Class yii\bootstrap\ActiveField

A Bootstrap 3 enhanced version of yii\widgets\ActiveField.

This class adds some useful features to ActiveField to render all sorts of Bootstrap 3 form fields in different form layouts:

• $inputTemplate is an optional template to render complex inputs, for example input groups
• $horizontalCssClasses defines the CSS grid classes to add to label, wrapper, error and hint in horizontal forms
• inline()/inline() is used to render inline checkboxList() and radioList()
• $enableError can be set to false to disable to the error
• $enableLabel can be set to false to disable to the label
• label() can be used with a bool argument to enable/disable the label

There are also some new placeholders that you can use in the $template configuration:

• {beginLabel}: the opening label tag
• {labelTitle}: the label title for use with {beginLabel}/{endLabel}
• {endLabel}: the closing label tag
• {beginWrapper}: the opening wrapper tag
• {endWrapper}: the closing wrapper tag

The wrapper tag is only used for some layouts and form elements.

Note that some elements use slightly different defaults for $template and other options. You may want to override those predefined templates for checkboxes, radio buttons, checkboxLists and radioLists in the fieldConfig of the yii\widgets\ActiveForm:

• $checkboxTemplate the template for checkboxes in default layout
• $radioTemplate the template for radio buttons in default layout
• $horizontalCheckboxTemplate the template for checkboxes in horizontal layout
• $horizontalRadioTemplate the template for radio buttons in horizontal layout
• $inlineCheckboxListTemplate the template for inline checkboxLists
• $inlineRadioListTemplate the template for inline radioLists

Example:

use yii\bootstrap\ActiveForm;

$form = ActiveForm::begin(['layout' => 'horizontal']);

// Form field without label
echo $form->field($model, 'demo', [
    'inputOptions' => [
        'placeholder' => $model->getAttributeLabel('demo'),
    ],
])->label(false);

// Inline radio list
echo $form->field($model, 'demo')->inline()->radioList($items);

// Control sizing in horizontal mode
echo $form->field($model, 'demo', [
    'horizontalCssClasses' => [
        'wrapper' => 'col-sm-2',
    ]
]);

// With 'default' layout you would use 'template' to size a specific field:
echo $form->field($model, 'demo', [
    'template' => '{label} <div class="row"><div class="col-sm-4">{input}{error}{hint}</div></div>'
]);

// Input group
echo $form->field($model, 'demo', [
    'inputTemplate' => '<div class="input-group"><span class="input-group-addon">@</span>{input}</div>',
]);

ActiveForm::end();

See also:

• yii\bootstrap\ActiveForm
• http://getbootstrap.com/css/#forms