Class yii\bootstrap4\ActiveForm
| Inheritance | yii\bootstrap4\ActiveForm » yii\widgets\ActiveForm |
|---|
A Bootstrap 4 enhanced version of \yii\widgets\ActiveForm.
This class mainly adds the $layout property to choose a Bootstrap 4 form layout. So for example to render a horizontal form you would:
use yii\bootstrap4\ActiveForm;
$form = ActiveForm::begin(['layout' => 'horizontal'])
This will set default values for the yii\bootstrap4\ActiveField
to render horizontal form fields. In particular the yii\bootstrap4\ActiveField::template
is set to {label} {beginWrapper} {input} {error} {endWrapper} {hint} and the
horizontalCssClasses are set to:
[
'offset' => 'offset-sm-3',
'label' => 'col-sm-3',
'wrapper' => 'col-sm-6',
'error' => '',
'hint' => 'col-sm-3',
]
To get a different column layout in horizontal mode you can modify those options through \yii\bootstrap4\fieldConfig:
$form = ActiveForm::begin([
'layout' => 'horizontal',
'fieldConfig' => [
'template' => "{label}\n{beginWrapper}\n{input}\n{hint}\n{error}\n{endWrapper}",
'horizontalCssClasses' => [
'label' => 'col-sm-4',
'offset' => 'offset-sm-4',
'wrapper' => 'col-sm-8',
'error' => '',
'hint' => '',
],
],
]);
See also:
- yii\bootstrap4\ActiveField for details on the \yii\bootstrap4\fieldConfig options.
- http://getbootstrap.com/css/#forms
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $errorCssClass | string | The CSS class that is added to a field container when the associated attribute has validation error. | yii\bootstrap4\ActiveForm |
| $errorSummaryCssClass | yii\bootstrap4\ActiveForm | ||
| $fieldClass | string | The default field class name when calling field() to create a new field. | yii\bootstrap4\ActiveForm |
| $layout | string | The form layout. | yii\bootstrap4\ActiveForm |
| $options | array | HTML attributes for the form tag. | yii\bootstrap4\ActiveForm |
| $successCssClass | yii\bootstrap4\ActiveForm | ||
| $validationStateOn | yii\bootstrap4\ActiveForm |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| field() | yii\bootstrap4\ActiveForm | |
| init() | yii\bootstrap4\ActiveForm |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| LAYOUT_DEFAULT | 'default' | Default form layout | yii\bootstrap4\ActiveForm |
| LAYOUT_HORIZONTAL | 'horizontal' | Horizontal form layout | yii\bootstrap4\ActiveForm |
| LAYOUT_INLINE | 'inline' | Inline form layout | yii\bootstrap4\ActiveForm |
Property Details
The CSS class that is added to a field container when the associated attribute has validation error.
The default field class name when calling field() to create a new field.
See also \yii\bootstrap4\fieldConfig.
The form layout. Either LAYOUT_DEFAULT, LAYOUT_HORIZONTAL or LAYOUT_INLINE. By choosing a layout, an appropriate default field configuration is applied. This will render the form fields with slightly different markup for each layout. You can override these defaults through \yii\bootstrap4\fieldConfig.
See also yii\bootstrap4\ActiveField for details on Bootstrap 4 field configuration.
HTML attributes for the form tag. Default is [].