Class yii\bootstrap4\ActiveField

Inheritanceyii\bootstrap4\ActiveField » yii\widgets\ActiveField

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

This class adds some useful features to \yii\widgets\ActiveField to render all sorts of Bootstrap 4 form fields in different form layouts:

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 \yii\widgets\ActiveForm::fieldConfig of the \yii\widgets\ActiveForm:

Example:

use yii\bootstrap4\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"><div class="input-group-prepend">
        <span class="input-group-text">@</span>
    </div>{input}</div>',
]);

ActiveForm::end();

See also:

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$checkEnclosedTemplate string The enclosed by label template for checkboxes and radios in default layout yii\bootstrap4\ActiveField
$checkHorizontalTemplate string The template for checkboxes and radios in horizontal layout yii\bootstrap4\ActiveField
$checkOptions array The default options for the input checkboxes. yii\bootstrap4\ActiveField
$checkTemplate string The template for checkboxes in default layout yii\bootstrap4\ActiveField
$enableError boolean Whether to render the error. yii\bootstrap4\ActiveField
$enableLabel boolean Whether to render the label. yii\bootstrap4\ActiveField
$errorOptions yii\bootstrap4\ActiveField
$hintOptions yii\bootstrap4\ActiveField
$horizontalCssClasses null|array CSS grid classes for horizontal layout. yii\bootstrap4\ActiveField
$inline boolean Whether to render checkboxList() and radioList() inline. yii\bootstrap4\ActiveField
$inputOptions yii\bootstrap4\ActiveField
$inputTemplate string|null Optional template to render the {input} placeholder content yii\bootstrap4\ActiveField
$labelOptions yii\bootstrap4\ActiveField
$options yii\bootstrap4\ActiveField
$radioHorizontalTemplate string The template for checkboxes and radios in horizontal layout yii\bootstrap4\ActiveField
$radioOptions array The default options for the input radios. yii\bootstrap4\ActiveField
$radioTemplate string The template for radios in default layout yii\bootstrap4\ActiveField
$wrapperOptions array Options for the wrapper tag, used in the {beginWrapper} placeholder yii\bootstrap4\ActiveField

Property Details

$checkEnclosedTemplate public property

The enclosed by label template for checkboxes and radios in default layout

public string $checkEnclosedTemplate "<div class=\"form-check\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n</div>"
$checkHorizontalTemplate public property

The template for checkboxes and radios in horizontal layout

public string $checkHorizontalTemplate "{beginWrapper}\n<div class=\"custom-control custom-checkbox\">\n{input}\n{label}\n{error}\n{hint}\n</div>\n{endWrapper}"
$checkOptions public property (available since version 2.0.7)

The default options for the input checkboxes. The parameter passed to individual input methods (e.g. checkbox()) will be merged with this property when rendering the input tag.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $checkOptions = ['class' => ['widget' => 'custom-control-input'], 'labelOptions' => ['class' => ['widget' => 'custom-control-label']]]
$checkTemplate public property

The template for checkboxes in default layout

public string $checkTemplate "<div class=\"custom-control custom-checkbox\">\n{input}\n{label}\n{error}\n{hint}\n</div>"
$enableError public property

Whether to render the error. Default is true except for layout inline.

public boolean $enableError true
$enableLabel public property

Whether to render the label. Default is true.

public boolean $enableLabel true
$errorOptions public property
public $errorOptions = ['class' => 'invalid-feedback']
$hintOptions public property
public $hintOptions = ['class' => ['widget' => 'form-text''text-muted'], 'tag' => 'small']
$horizontalCssClasses public property

CSS grid classes for horizontal layout. This must be an array with these keys:

  • 'offset' the offset grid class to append to the wrapper if no label is rendered
  • 'label' the label grid class
  • 'wrapper' the wrapper grid class
  • 'error' the error grid class
  • 'hint' the hint grid class
$inline public property

Whether to render checkboxList() and radioList() inline.

public boolean $inline false
$inputOptions public property
public $inputOptions = ['class' => ['widget' => 'form-control']]
$inputTemplate public property

Optional template to render the {input} placeholder content

public string|null $inputTemplate null
$labelOptions public property
public $labelOptions = []
$options public property
public $options = ['class' => ['widget' => 'form-group']]
$radioHorizontalTemplate public property (available since version 2.0.5)

The template for checkboxes and radios in horizontal layout

public string $radioHorizontalTemplate "{beginWrapper}\n<div class=\"custom-control custom-radio\">\n{input}\n{label}\n{error}\n{hint}\n</div>\n{endWrapper}"
$radioOptions public property (available since version 2.0.7)

The default options for the input radios. The parameter passed to individual input methods (e.g. radio()) will be merged with this property when rendering the input tag.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $radioOptions = ['class' => ['widget' => 'custom-control-input'], 'labelOptions' => ['class' => ['widget' => 'custom-control-label']]]
$radioTemplate public property (available since version 2.0.5)

The template for radios in default layout

public string $radioTemplate "<div class=\"custom-control custom-radio\">\n{input}\n{label}\n{error}\n{hint}\n</div>"
$wrapperOptions public property

Options for the wrapper tag, used in the {beginWrapper} placeholder

public array $wrapperOptions = []

Method Details

__construct() public method

public void __construct ( $config = [] )
$config
checkbox() public method

public void checkbox ( $options = [], $enclosedByLabel false )
$options
$enclosedByLabel
checkboxList() public method

public void checkboxList ( $items, $options = [] )
$items
$options
createLayoutConfig() protected method

protected array createLayoutConfig ( $instanceConfig )
$instanceConfig array

The configuration passed to this instance's constructor

return array

The layout specific default configuration for this instance

public void dropdownList ( $items, $options = [] )
$items
$options
fileInput() public method

public void fileInput ( $options = [] )
$options
inline() public method

public $this inline ( $value true )
$value boolean

Whether to render a inline list

return $this

The field object itself Make sure you call this method before checkboxList() or radioList() to have any effect.

label() public method

public void label ( $label null, $options = [] )
$label
$options
listBox() public method

public void listBox ( $items, $options = [] )
$items
$options
radio() public method

public void radio ( $options = [], $enclosedByLabel false )
$options
$enclosedByLabel
radioList() public method

public void radioList ( $items, $options = [] )
$items
$options
render() public method

public void render ( $content null )
$content
renderLabelParts() protected method

protected void renderLabelParts ( $label null, $options = [] )
$label string|null

The label or null to use model label

$options array

The tag options

staticControl() public method

Renders Bootstrap static form control.

See also https://getbootstrap.com/docs/4.2/components/forms/#readonly-plain-text.

public $this staticControl ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. There are also a special options:

  • encode: bool, whether value should be HTML-encoded or not.
return $this

The field object itself