From 3a943df1579505430e42ec05a986c5bb508cdc7d Mon Sep 17 00:00:00 2001 From: Nobuo Kihara Date: Fri, 29 May 2015 00:19:04 +0900 Subject: [PATCH 1/2] docs/guide/usage-widgets.md revised for readability [ci skip] --- docs/guide/usage-widgets.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/guide/usage-widgets.md b/docs/guide/usage-widgets.md index 6b63e72..ac3aef1 100644 --- a/docs/guide/usage-widgets.md +++ b/docs/guide/usage-widgets.md @@ -19,15 +19,14 @@ framework features. All widgets belong to `\yii\bootstrap` namespace: - [[yii\bootstrap\Tabs|Tabs]] -## Customize widget CSS classes +## Customizing widget CSS classes -Widgets allow quick composition of the HTML for particular Bootstrap components, which requires usage of the -Bootstrap CSS classes. Those classes are added automatically by the widgets. However usually widget provides -fields or properties, which allow customization of the CSS styles for particular HTML tags. +These widgets allow quick composition of the HTML for the Bootstrap components that require the use of the Bootstrap CSS classes. +The default class for the component is added automatically by the widget, and the optional classes that you may want to customize are usually supported through the properties of the widget. -For example: you may use [[yii\bootstrap\Button::options]] to customize appearance of the rendered button. -Class 'btn' will be added automatically, so you don't need to worry about it. All you need is specify particular -button class: +For example, you may use [[yii\bootstrap\Button::options]] to customize the appearance of a button. +The class 'btn' which is required for a button will be added automatically, so you don't need to worry about it. +All you need is specify a particular button class: ```php echo Button::widget([ @@ -36,17 +35,16 @@ echo Button::widget([ ]); ``` -However, sometimes you may need to replace standard class, added by the widget, with alternative one. -For example: widget [[yii\bootstrap\ButtonGroup]] uses 'btn-group' class for the container div, but you may -need to use 'btn-group-vertical', which allows vertical-style layout for the buttons. Using plain 'class' option -simply adds 'btn-group-vertical' to 'btn-group', which produces incorrect result. -In order to actually replace class added by widget, you need to specify 'class' option as array, containing -needed class name under the 'widget' key: +However, sometimes you may need to replace the default class with an alternative one. +For example, the widget [[yii\bootstrap\ButtonGroup]] uses 'btn-group' class for the container div by default, +but you may need to use 'btn-group-vertical' instead to align the buttons vertically. +Using a plain 'class' option simply adds 'btn-group-vertical' to 'btn-group', which will produce an incorrect result. +In order to override the default class of a widget, you need to specify the 'class' option as an array that contains the customized class name under the 'widget' key: ```php echo ButtonGroup::widget([ 'options' => [ - 'class' => ['widget' => 'btn-group-vertical'] // replace 'btn-group' with 'btn-group-vertical' + 'class' => ['widget' => 'btn-group-vertical'] // replaces 'btn-group' with 'btn-group-vertical' ], 'buttons' => [ ['label' => 'A'], From b945f9ea3d80e445eb52fd0192abcbfa7c7c8eb0 Mon Sep 17 00:00:00 2001 From: Nobuo Kihara Date: Fri, 29 May 2015 07:28:49 +0900 Subject: [PATCH 2/2] docs/guide/usage-widgets.md - updated [ci skip] --- docs/guide/usage-widgets.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guide/usage-widgets.md b/docs/guide/usage-widgets.md index ac3aef1..8adcfec 100644 --- a/docs/guide/usage-widgets.md +++ b/docs/guide/usage-widgets.md @@ -21,8 +21,8 @@ framework features. All widgets belong to `\yii\bootstrap` namespace: ## Customizing widget CSS classes -These widgets allow quick composition of the HTML for the Bootstrap components that require the use of the Bootstrap CSS classes. -The default class for the component is added automatically by the widget, and the optional classes that you may want to customize are usually supported through the properties of the widget. +The widgets allow quick composition of the HTML for the bootstrap components that require the bootstrap CSS classes. +The default classes for a particular component will be added automatically by the widget, and the optional classes that you may want to customize are usually supported through the properties of the widget. For example, you may use [[yii\bootstrap\Button::options]] to customize the appearance of a button. The class 'btn' which is required for a button will be added automatically, so you don't need to worry about it. @@ -35,11 +35,11 @@ echo Button::widget([ ]); ``` -However, sometimes you may need to replace the default class with an alternative one. +However, sometimes you may need to replace the default classes with the alternative ones. For example, the widget [[yii\bootstrap\ButtonGroup]] uses 'btn-group' class for the container div by default, but you may need to use 'btn-group-vertical' instead to align the buttons vertically. Using a plain 'class' option simply adds 'btn-group-vertical' to 'btn-group', which will produce an incorrect result. -In order to override the default class of a widget, you need to specify the 'class' option as an array that contains the customized class name under the 'widget' key: +In order to override the default classes of a widget, you need to specify the 'class' option as an array that contains the customized class definition under the 'widget' key: ```php echo ButtonGroup::widget([