From d6833076c5003b863ba45d41ebd79f533852beb7 Mon Sep 17 00:00:00 2001 From: Simon Karlen Date: Tue, 3 Aug 2021 10:22:50 +0200 Subject: [PATCH] updated docs --- docs/guide-de/README.md | 2 +- docs/guide-de/asset-bundles.md | 10 +-- docs/guide-de/assets-setup.md | 18 +++--- docs/guide-de/basic-usage.md | 2 +- docs/guide-de/helper-html.md | 12 ++-- docs/guide-de/installation.md | 4 +- docs/guide-de/migrating-yii2-bootstrap.md | 75 +---------------------- docs/guide-de/topics-sass.md | 4 +- docs/guide-de/usage-widgets.md | 40 ++++++------ docs/guide-es/README.md | 2 +- docs/guide-es/asset-bundles.md | 10 +-- docs/guide-es/basic-usage.md | 2 +- docs/guide-es/helper-html.md | 12 ++-- docs/guide-es/installation.md | 2 +- docs/guide-es/topics-sass.md | 4 +- docs/guide-es/usage-widgets.md | 43 +++++++------ docs/guide-ja/README.md | 2 +- docs/guide-ja/asset-bundles.md | 10 +-- docs/guide-ja/assets-setup.md | 18 +++--- docs/guide-ja/basic-usage.md | 2 +- docs/guide-ja/helper-html.md | 12 ++-- docs/guide-ja/installation.md | 2 +- docs/guide-ja/migrating-yii2-bootstrap.md | 72 +--------------------- docs/guide-ja/topics-sass.md | 4 +- docs/guide-ja/usage-widgets.md | 43 +++++++------ docs/guide-pt-BR/README.md | 2 +- docs/guide-pt-BR/asset-bundles.md | 10 +-- docs/guide-pt-BR/basic-usage.md | 2 +- docs/guide-pt-BR/helper-html.md | 10 +-- docs/guide-pt-BR/installation.md | 2 +- docs/guide-pt-BR/topics-sass.md | 2 +- docs/guide-pt-BR/usage-widgets.md | 39 ++++++------ docs/guide-ru/README.md | 2 +- docs/guide-ru/asset-bundles.md | 8 +-- docs/guide-ru/basic-usage.md | 2 +- docs/guide-ru/helper-html.md | 10 +-- docs/guide-ru/installation.md | 2 +- docs/guide-ru/topics-sass.md | 4 +- docs/guide-ru/usage-widgets.md | 43 +++++++------ docs/guide-uk/README.md | 2 +- docs/guide-uk/basic-usage.md | 2 +- docs/guide-uk/installation.md | 2 +- docs/guide-uk/topics-sass.md | 4 +- docs/guide-uk/usage-widgets.md | 39 ++++++------ docs/guide-zh-CN/README.md | 2 +- docs/guide-zh-CN/asset-bundles.md | 8 +-- docs/guide-zh-CN/basic-usage.md | 4 +- docs/guide-zh-CN/helper-html.md | 12 ++-- docs/guide-zh-CN/installation.md | 2 +- docs/guide-zh-CN/topics-sass.md | 4 +- docs/guide-zh-CN/usage-widgets.md | 43 +++++++------ docs/guide/asset-bundles.md | 10 +-- docs/guide/assets-setup.md | 18 +++--- docs/guide/basic-usage.md | 2 +- docs/guide/helper-html.md | 12 ++-- docs/guide/installation.md | 4 +- docs/guide/migrating-yii2-bootstrap.md | 70 --------------------- docs/guide/topics-sass.md | 4 +- docs/guide/usage-widgets.md | 43 +++++++------ 59 files changed, 320 insertions(+), 512 deletions(-) diff --git a/docs/guide-de/README.md b/docs/guide-de/README.md index 0a203d8..bcaf598 100644 --- a/docs/guide-de/README.md +++ b/docs/guide-de/README.md @@ -1,7 +1,7 @@ Twitter Bootstrap Erweiterung für Yii 2 ======================================= -Diese Erweiterung enthält Unterstützung für das [Bootstrap 4 Framework](http://getbootstrap.com/) (auch bekannt als "Twitter Bootstrap") +Diese Erweiterung enthält Unterstützung für das [Bootstrap 5 Framework](http://getbootstrap.com/) (auch bekannt als "Twitter Bootstrap") Markup und dessen Komponenten. Bootstrap ist eine exzellentes, reponsives Framework welches den clientseitigen Entwicklungsprozess vehement zu verkürzen vermag. diff --git a/docs/guide-de/asset-bundles.md b/docs/guide-de/asset-bundles.md index 0b3a7db..898dbb9 100644 --- a/docs/guide-de/asset-bundles.md +++ b/docs/guide-de/asset-bundles.md @@ -5,11 +5,11 @@ Bootstrap ist eine komplexe Front-End-Lösung, welche CSS, Javascript, Schriften Um Ihnen die flexibelste Kontrolle über die einzelnen Komponenten zu ermöglichen enthält diese Erweiterung verschiedene Asset Bundles. Das sind: -- [[yii\bootstrap4\BootstrapAsset|BootstrapAsset]] - enthält nur das hauptsächliche CSS. -- [[yii\bootstrap4\BootstrapPluginAsset|BootstrapPluginAsset]] - enthält das Javascript. Abhängig von [[yii\bootstrap4\BootstrapAsset]]. +- [[yii\bootstrap5\BootstrapAsset|BootstrapAsset]] - enthält nur das hauptsächliche CSS. +- [[yii\bootstrap5\BootstrapPluginAsset|BootstrapPluginAsset]] - enthält das Javascript. Abhängig von [[yii\bootstrap5\BootstrapAsset]]. Verschiedene Anwendunganforderungen erfordern verschiedene Bundles (bzw. Kombinationen). -Falls Sie nur auf das CSS angewiesen sind, reicht es wenn Sie [[yii\bootstrap4\BootstrapAsset]] laden. -Wenn Sie das Javascript verwenden möchten, müssen Sie [[yii\bootstrap4\BootstrapPluginAsset]] auch laden. +Falls Sie nur auf das CSS angewiesen sind, reicht es wenn Sie [[yii\bootstrap5\BootstrapAsset]] laden. +Wenn Sie das Javascript verwenden möchten, müssen Sie [[yii\bootstrap5\BootstrapPluginAsset]] auch laden. -> Tipp: Die meisten Widgets laden [[yii\bootstrap4\BootstrapPluginAsset]] automatisch. +> Tipp: Die meisten Widgets laden [[yii\bootstrap5\BootstrapPluginAsset]] automatisch. diff --git a/docs/guide-de/assets-setup.md b/docs/guide-de/assets-setup.md index 4c01ac8..29ba30b 100644 --- a/docs/guide-de/assets-setup.md +++ b/docs/guide-de/assets-setup.md @@ -77,7 +77,7 @@ Fügen Sie zur `composer.json`-Datei Ihres Projekts folgende Zeilen hinzu zum Ve ```json "replace": { - "npm-asset/bootstrap": ">=4.2.1" + "npm-asset/bootstrap": ">=5.0.2" }, ``` @@ -89,7 +89,7 @@ Fügen Sie zur `composer.json`-Datei Ihres Projekts folgende Zeilen hinzu zum Ve ```json "replace": { - "npm-asset/bootstrap": ">=4.2.1" + "npm-asset/bootstrap": ">=5.0.2" }, ``` @@ -101,16 +101,16 @@ return [ 'assetManager' => [ // override bundles to use CDN : 'bundles' => [ - 'yii\bootstrap4\BootstrapAsset' => [ + 'yii\bootstrap5\BootstrapAsset' => [ 'sourcePath' => null, - 'baseUrl' => 'https://stackpath.bootstrapcdn.com/bootstrap/4.2.1', + 'baseUrl' => 'https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/', 'css' => [ 'css/bootstrap.min.css' ], ], - 'yii\bootstrap4\BootstrapPluginAsset' => [ + 'yii\bootstrap5\BootstrapPluginAsset' => [ 'sourcePath' => null, - 'baseUrl' => 'https://maxcdn.bootstrapcdn.com/bootstrap/4.2.1', + 'baseUrl' => 'https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/', 'js' => [ 'js/bootstrap.bundle.min.js' ], @@ -135,7 +135,7 @@ Fügen Sie zur `composer.json`-Datei Ihres Projekts folgende Zeilen hinzu zum Ve ```json "replace": { - "npm-asset/bootstrap": ">=4.2.1" + "npm-asset/bootstrap": ">=5.0.2" }, ``` @@ -147,13 +147,13 @@ return [ 'assetManager' => [ // override bundles to use local project files : 'bundles' => [ - 'yii\bootstrap4\BootstrapAsset' => [ + 'yii\bootstrap5\BootstrapAsset' => [ 'sourcePath' => '@app/assets/source/bootstrap/dist', 'css' => [ YII_ENV_DEV ? 'css/bootstrap.css' : 'css/bootstrap.min.css', ], ], - 'yii\bootstrap4\BootstrapPluginAsset' => [ + 'yii\bootstrap5\BootstrapPluginAsset' => [ 'sourcePath' => '@app/assets/source/bootstrap/dist', 'js' => [ YII_ENV_DEV ? 'js/bootstrap.js' : 'js/bootstrap.min.js', diff --git a/docs/guide-de/basic-usage.md b/docs/guide-de/basic-usage.md index 84bcd4c..134ff26 100644 --- a/docs/guide-de/basic-usage.md +++ b/docs/guide-de/basic-usage.md @@ -9,7 +9,7 @@ im `@app/assets` Verzeichnis: ```php public $depends = [ 'yii\web\YiiAsset', - 'yii\bootstrap4\BootstrapAsset', // Diese Zeile + 'yii\bootstrap5\BootstrapAsset', // Diese Zeile ]; ``` diff --git a/docs/guide-de/helper-html.md b/docs/guide-de/helper-html.md index 929dfbb..23440b0 100644 --- a/docs/guide-de/helper-html.md +++ b/docs/guide-de/helper-html.md @@ -4,18 +4,18 @@ HTML helper Bootstrap führt viele konsistente HTML Strukturen ein, welche es erlauben, verschiedene visuelle Effekte einfach zu verwenden. Ausschliesslich die komplexesten von ihnen sind mittels Widgets in dieser Erweiterung umgesetzt worden. Der Rest kann manuell mittels HTML zusammengestellt werden. -Einige spezielle Bootstrap Markups sind implementiert im [[\yii\bootstrap4\Html]]-Helper. -Die [[\yii\bootstrap4\Html]]-Klasse ist eine Erweiterung der regulären [[\yii\helpers\Html]]-Klasse mit Anpassungen zur +Einige spezielle Bootstrap Markups sind implementiert im [[\yii\bootstrap5\Html]]-Helper. +Die [[\yii\bootstrap5\Html]]-Klasse ist eine Erweiterung der regulären [[\yii\helpers\Html]]-Klasse mit Anpassungen zur Verwendung mit Bootstrap. Sie bietet verschiedene nützliche Methoden. -Die [[\yii\bootstrap4\Html]]-Klasse erbt von der [[\yii\helpers\Html]]-Klasse und ersetzt diese dadurch vollumfänglich. +Die [[\yii\bootstrap5\Html]]-Klasse erbt von der [[\yii\helpers\Html]]-Klasse und ersetzt diese dadurch vollumfänglich. Sie benötigen folglich **nicht** beide in Ihren Views. Beispiel: ```php Html::tag('i', ['class' => 'fas fa-check']) . Html::encode('Save & apply'), @@ -24,5 +24,5 @@ use yii\bootstrap4\Html; ]); ?> ``` -> Vorsicht: Verwechseln Sie [[\yii\bootstrap4\Html]] und [[\yii\helpers\Html]] Klassen nicht und bedenken Sie jeweils +> Vorsicht: Verwechseln Sie [[\yii\bootstrap5\Html]] und [[\yii\helpers\Html]] Klassen nicht und bedenken Sie jeweils welche Sie in Ihren Views verwenden. diff --git a/docs/guide-de/installation.md b/docs/guide-de/installation.md index 0981aeb..494da27 100644 --- a/docs/guide-de/installation.md +++ b/docs/guide-de/installation.md @@ -8,13 +8,13 @@ Der empfohlene Weg zur Installation dieser Erweiterung ist mittels [composer](ht Führen Sie entweder folgenden Befehlt aus ``` -php composer.phar require --prefer-dist yiisoft/yii2-bootstrap4 +php composer.phar require --prefer-dist yiisoft/yii2-bootstrap5 ``` oder fügen Sie folgendes ``` -"yiisoft/yii2-bootstrap4": "~1.0.0" +"yiisoft/yii2-bootstrap5": "~1.0.0" ``` zur `require`-Sektion Ihrer `composer.json`-Datei hinzu. diff --git a/docs/guide-de/migrating-yii2-bootstrap.md b/docs/guide-de/migrating-yii2-bootstrap.md index dc92e11..59580ad 100644 --- a/docs/guide-de/migrating-yii2-bootstrap.md +++ b/docs/guide-de/migrating-yii2-bootstrap.md @@ -6,105 +6,32 @@ Die grössten Änderungen finden Sie hier zusammengefasst: ## Allgemein -* Der Namespace ist nun `yii\bootstrap4` anstatt `yii\bootstrap` -* Es wird das `npm` Paket verwendet anstatt das `bower` Paket -* Es gibt kein Theme Asset mehr -* `popper.js` muss nicht mehr extra installiert werden (wird vom Bootstrap JS Bundle mitgeliefert) +* Der Namespace ist nun `yii\bootstrap5` anstatt `yii\bootstrap4` ## Widgets / Klassen -* [[yii\bootstrap\Collapse|Collapse]] wurde umbenannt zu [[yii\bootstrap4\Accordion|Accordion]] -* [[yii\bootstrap\BootstrapThemeAsset|BootstrapThemeAsset]] wurde entfernt -* [[yii\bootstrap4\Breadcrumbs|Breadcrumbs]] wurde hinzugefügt (Bootstrap 4 Implementation von [[yii\widgets\Breadcrumbs]]) -* [[yii\bootstrap4\ButtonToolbar|ButtonToolbar]] wurde hinzugefügt (https://getbootstrap.com/docs/4.3/components/button-group/#button-toolbar) - - ### BaseHtml -Die Methode `icon` wurde entfernt. Sie macht keinen Sinn mehr, da Bootstrap 4 keine Icons mehr mit sich bringt. Eine -mögliche Alternative wäre das [Font Awesome Widget](https://github.com/rmrevin/yii2-fontawesome) oder aber das -[Font Awesome Inline Widget](https://github.com/YiiRocks/yii2-fontawesome-inline). - ### ActiveField -Folgende Properties wurden umbenannt: -* `$checkboxTemplate` zu `$checkTemplate`, -* `$horizontalCheckboxTemplate` zu `$checkHorizontalTemplate`, -* `$horizontalRadioTemplate` zu `$radioHorizontalTemplate` - -Die Properties `$inlineCheckboxListTemplate` und `$inlineRadioListTemplate` wurden entfernt. Dafür gibt es ein neues -Template mit dem Namen `$checkEnclosedTemplate`. In Bootstrap 4 sind Checkboxen standardmässig nicht mehr von Labeln -eingeschlossen. - ### ActiveForm -Hier wurden die Konstanten [[yii\bootstrap4\ActiveForm::LAYOUT_DEFAULT]], [[yii\bootstrap4\ActiveForm::LAYOUT_HORIZONTAL]] -und [[yii\bootstrap4\ActiveForm::LAYOUT_INLINE]] eingeführt. Sie sollen die Verwendung der Layout vereinfachen und bei -allfälligen Änderungen der Werte Folgefehler verhindern. - ### Breadcrumbs -Dieses Widget wurde neu eingeführt um die Korrekte Darstellung von Breadcrumbs im Bootstrap 4 Design zu gerwährleisten. -Es ist vollständig komptibel mit [[yii\widgets\Breadcrumbs]]. - ### ButtonDropdown -Dieses Widget hat ein neues Property mit Namen `$direction` erhalten. Es ermöglicht die Anzeige des Menüs auf z.B. der -rechten Seite des Buttons. Des weiteren gibt es die Konstanten [[yii\bootstrap4\ButtonDropdown::DIRECTION_DOWN]], -[[yii\bootstrap4\ButtonDropdown::DIRECTION_LEFT]], [[yii\bootstrap4\ButtonDropdown::DIRECTION_RIGHT]] und -[[yii\bootstrap4\ButtonDropdown::DIRECTION_UP]] um die Richtungsselektion zu vereinfachen. -Es wurde ein weiteres Property eingeführt mit dem Namen `$renderContainer`. Falls dieses auf `false` gestellt wird, wird -das rendern des das Dropdown umfassenden DIVs verhindert. - -Folgende Properties wurden umbenannt: -* `$containerOptions` zu `$options`, -* `$options` zu `$buttonOptions` - ### ButtonToolbar -Dieses Widget wurde eingeführt um einfach Button-Toolbars zu erstellen. Weitere Informationen erhalten Sie unter -https://getbootstrap.com/docs/4.3/components/button-group/#button-toolbar. - ### Carousel -Dieses Widget hat das Property `$crossfade` erhalten. Es erlaubt das Ändern der Animation zwischen den Slides auf ein Fade, -anstatt eines Slided wenn es auf `true` gestellt wird. - ### LinkPager -Dieses neue Widget repräsentiert die Bootstrap Version von [[yii\widgets\LinkPager]]. Es rendert eine Pagination im Bootstrap -Stil. Weitere Informationen erhalten Sie unter https://getbootstrap.com/docs/4.3/components/pagination/. - ### Modal -Folgende Properties wurden umbenannt: -* `$header` zu `$title`, -* `$headerOptions` zu `$titleOptions` - -Des Weiteren ist es nicht mehr von nöten, beim `$title` die Titel-Tags `