mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-09 01:27:20 +08:00
added a large amount of missing documentation
This commit is contained in:
@ -40,6 +40,8 @@ class ActiveField extends Component
|
||||
* The following special options are recognized:
|
||||
*
|
||||
* - tag: the tag name of the container element. Defaults to "div".
|
||||
*
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'form-group'];
|
||||
/**
|
||||
@ -50,6 +52,7 @@ class ActiveField extends Component
|
||||
/**
|
||||
* @var array the default options for the input tags. The parameter passed to individual input methods
|
||||
* (e.g. [[textInput()]]) will be merged with this property when rendering the input tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $inputOptions = ['class' => 'form-control'];
|
||||
/**
|
||||
@ -58,11 +61,14 @@ class ActiveField extends Component
|
||||
* The following special options are recognized:
|
||||
*
|
||||
* - tag: the tag name of the container element. Defaults to "div".
|
||||
*
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $errorOptions = ['class' => 'help-block'];
|
||||
/**
|
||||
* @var array the default options for the label tags. The parameter passed to [[label()]] will be
|
||||
* merged with this property when rendering the label tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $labelOptions = ['class' => 'control-label'];
|
||||
/**
|
||||
@ -71,6 +77,8 @@ class ActiveField extends Component
|
||||
* The following special options are recognized:
|
||||
*
|
||||
* - tag: the tag name of the container element. Defaults to "div".
|
||||
*
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $hintOptions = ['class' => 'hint-block'];
|
||||
/**
|
||||
|
||||
@ -34,8 +34,7 @@ class ActiveForm extends Widget
|
||||
public $method = 'post';
|
||||
/**
|
||||
* @var array the HTML attributes (name-value pairs) for the form tag.
|
||||
* The values will be HTML-encoded using [[\yii\helpers\Html::encode()]].
|
||||
* If a value is null, the corresponding attribute will not be rendered.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = [];
|
||||
/**
|
||||
|
||||
@ -22,6 +22,7 @@ abstract class BaseListView extends Widget
|
||||
/**
|
||||
* @var array the HTML attributes for the container tag of the list view.
|
||||
* The "tag" element specifies the tag name of the container element and defaults to "div".
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = [];
|
||||
/**
|
||||
|
||||
@ -53,6 +53,7 @@ class Breadcrumbs extends Widget
|
||||
public $tag = 'ul';
|
||||
/**
|
||||
* @var array the HTML attributes for the breadcrumb container tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'breadcrumb'];
|
||||
/**
|
||||
|
||||
@ -91,6 +91,7 @@ class DetailView extends Widget
|
||||
/**
|
||||
* @var array the HTML attributes for the container tag of this widget. The "tag" option specifies
|
||||
* what container tag should be used. It defaults to "table" if not set.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'table table-striped table-bordered detail-view'];
|
||||
/**
|
||||
@ -100,6 +101,7 @@ class DetailView extends Widget
|
||||
*/
|
||||
public $formatter;
|
||||
|
||||
|
||||
/**
|
||||
* Initializes the detail view.
|
||||
* This method will initialize required property values.
|
||||
|
||||
@ -43,6 +43,7 @@ class InputWidget extends Widget
|
||||
public $value;
|
||||
/**
|
||||
* @var array the HTML attributes for the input tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = [];
|
||||
|
||||
|
||||
@ -35,10 +35,12 @@ class LinkPager extends Widget
|
||||
public $pagination;
|
||||
/**
|
||||
* @var array HTML attributes for the pager container tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'pagination'];
|
||||
/**
|
||||
* @var array HTML attributes for the link in a pager container tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $linkOptions = [];
|
||||
/**
|
||||
|
||||
@ -34,7 +34,8 @@ class LinkSorter extends Widget
|
||||
public $attributes;
|
||||
/**
|
||||
* @var array HTML attributes for the sorter container tag.
|
||||
* See [[\yii\helpers\Html::ul()]] for special attributes.
|
||||
* @see \yii\helpers\Html::ul() for special attributes.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'sorter'];
|
||||
|
||||
|
||||
@ -22,6 +22,7 @@ class ListView extends BaseListView
|
||||
* @var array the HTML attributes for the container of the rendering result of each data model.
|
||||
* The "tag" element specifies the tag name of the container element and defaults to "div".
|
||||
* If "tag" is false, it means no container element will be rendered.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $itemOptions = [];
|
||||
/**
|
||||
@ -55,6 +56,7 @@ class ListView extends BaseListView
|
||||
/**
|
||||
* @var array the HTML attributes for the container tag of the list view.
|
||||
* The "tag" element specifies the tag name of the container element and defaults to "div".
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'list-view'];
|
||||
|
||||
|
||||
@ -63,6 +63,7 @@ class MaskedInput extends InputWidget
|
||||
public $completed;
|
||||
/**
|
||||
* @var array the HTML attributes for the input tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = ['class' => 'form-control'];
|
||||
|
||||
|
||||
@ -74,6 +74,8 @@ class Menu extends Widget
|
||||
* by the "options" set in individual [[items]]. The following special options are recognized:
|
||||
*
|
||||
* - tag: string, defaults to "li", the tag name of the item container tags.
|
||||
*
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $itemOptions = [];
|
||||
/**
|
||||
@ -122,6 +124,8 @@ class Menu extends Widget
|
||||
* @var array the HTML attributes for the menu's container tag. The following special options are recognized:
|
||||
*
|
||||
* - tag: string, defaults to "ul", the tag name of the item container tags.
|
||||
*
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = [];
|
||||
/**
|
||||
|
||||
@ -45,6 +45,7 @@ class Pjax extends Widget
|
||||
{
|
||||
/**
|
||||
* @var array the HTML attributes for the widget container tag.
|
||||
* See [[\yii\helpers\Html::renderTagAttributes()]] for details on how attributes are being rendered.
|
||||
*/
|
||||
public $options = [];
|
||||
/**
|
||||
@ -79,7 +80,7 @@ class Pjax extends Widget
|
||||
*/
|
||||
public $scrollTo = false;
|
||||
/**
|
||||
* @var array additional options to be passed to the pjax JS plugin. Please refer to
|
||||
* @var array additional options to be passed to the pjax JS plugin. Please refer to the
|
||||
* [pjax project page](https://github.com/yiisoft/jquery-pjax) for available options.
|
||||
*/
|
||||
public $clientOptions;
|
||||
|
||||
Reference in New Issue
Block a user