Class yii\bootstrap5\ActiveField

All Classes | Properties | Methods
Inheritanceyii\bootstrap5\ActiveField » yii\widgets\ActiveField » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Source Code https://github.com/yiisoft/yii2/blob/master/framework/bootstrap5/ActiveField.php

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

This class adds some useful features to ActiveField to render all sorts of Bootstrap 5 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 fieldConfig of the yii\widgets\ActiveForm:

Example:

use yii\bootstrap5\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
$addAriaAttributes boolean Adds aria HTML attributes aria-required and aria-invalid for inputs yii\widgets\ActiveField
$attribute string The model attribute that this field is associated with. yii\widgets\ActiveField
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$checkEnclosedTemplate string The enclosed by label template for checkboxes and radios in default layout yii\bootstrap5\ActiveField
$checkHorizontalTemplate string The template for checkboxes and radios in horizontal layout yii\bootstrap5\ActiveField
$checkOptions array The default options for the input checkboxes. yii\bootstrap5\ActiveField
$checkTemplate string The template for checkboxes in default layout yii\bootstrap5\ActiveField
$enableAjaxValidation boolean|null Whether to enable AJAX-based data validation. yii\widgets\ActiveField
$enableClientValidation boolean|null Whether to enable client-side data validation. yii\widgets\ActiveField
$enableError boolean Whether to render the error. yii\bootstrap5\ActiveField
$enableLabel boolean Whether to render the label. yii\bootstrap5\ActiveField
$errorOptions array The default options for the error tags. yii\bootstrap5\ActiveField
$form yii\widgets\ActiveForm The form that this field is associated with. yii\widgets\ActiveField
$hintOptions array The default options for the hint tags. yii\bootstrap5\ActiveField
$horizontalCssClasses null|array CSS grid classes for horizontal layout. yii\bootstrap5\ActiveField
$inline boolean Whether to render checkboxList() and radioList() inline. yii\bootstrap5\ActiveField
$inputOptions array The default options for the input tags. yii\bootstrap5\ActiveField
$inputTemplate string|null Optional template to render the {input} placeholder content yii\bootstrap5\ActiveField
$labelOptions array The default options for the label tags. yii\bootstrap5\ActiveField
$model yii\base\Model The data model that this field is associated with. yii\widgets\ActiveField
$options array The HTML attributes (name-value pairs) for the field container tag. yii\bootstrap5\ActiveField
$parts array Different parts of the field (e.g. input, label). yii\widgets\ActiveField
$radioHorizontalTemplate string The template for checkboxes and radios in horizontal layout yii\bootstrap5\ActiveField
$radioOptions array The default options for the input radios. yii\bootstrap5\ActiveField
$radioTemplate string The template for radios in default layout yii\bootstrap5\ActiveField
$selectors array The jQuery selectors for selecting the container, input and error tags. yii\widgets\ActiveField
$switchEnclosedTemplate string Tthe enclosed by label template for switches(custom checkboxes) in default layout yii\bootstrap5\ActiveField
$switchHorizontalTemplate string The template for switches (custom checkboxes) in horizontal layout yii\bootstrap5\ActiveField
$switchTemplate string The template forswitches (custom checkboxes) in default layout yii\bootstrap5\ActiveField
$template string The template that is used to arrange the label, the input field, the error message and the hint text. yii\widgets\ActiveField
$validateOnBlur boolean|null Whether to perform validation when the input field loses focus. yii\widgets\ActiveField
$validateOnChange boolean|null Whether to perform validation when the value of the input field is changed. yii\widgets\ActiveField
$validateOnType boolean|null Whether to perform validation while the user is typing in the input field. yii\widgets\ActiveField
$validationDelay integer|null Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set true. yii\widgets\ActiveField
$wrapperOptions array Options for the wrapper tag, used in the {beginWrapper} placeholder yii\bootstrap5\ActiveField

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\bootstrap5\ActiveField
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__toString() PHP magic method that returns the string representation of this object. yii\widgets\ActiveField
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
begin() Renders the opening tag of the field container. yii\widgets\ActiveField
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
checkbox() {@inheritdoc} Enable option switch to render as toggle switch. yii\bootstrap5\ActiveField
checkboxList() Renders a list of checkboxes. yii\bootstrap5\ActiveField
className() Returns the fully qualified name of this class. yii\base\BaseObject
colorInput() Renders a color picker (custom input). yii\bootstrap5\ActiveField
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Renders the closing tag of the field container. yii\widgets\ActiveField
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
error() Generates a tag that contains the first validation error of $attribute. yii\widgets\ActiveField
fileInput() Renders a file input. yii\bootstrap5\ActiveField
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
hiddenInput() Renders a hidden input. yii\widgets\ActiveField
hint() Renders the hint tag. yii\widgets\ActiveField
init() Initializes the object. yii\base\BaseObject
inline() yii\bootstrap5\ActiveField
input() Renders an input tag. yii\widgets\ActiveField
label() Generates a label tag for $attribute. yii\bootstrap5\ActiveField
listBox() Renders a list box. yii\bootstrap5\ActiveField
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
passwordInput() Renders a password input. yii\widgets\ActiveField
radio() Renders a radio button. yii\bootstrap5\ActiveField
radioList() Renders a list of radio buttons. yii\bootstrap5\ActiveField
rangeInput() Renders a range (custom input). yii\bootstrap5\ActiveField
render() Renders the whole field. yii\bootstrap5\ActiveField
staticControl() Renders Bootstrap static form control. yii\bootstrap5\ActiveField
textInput() Renders a text input. yii\widgets\ActiveField
textarea() Renders a text area. yii\widgets\ActiveField
trigger() Triggers an event. yii\base\Component
widget() Renders a widget as the input of the field. yii\widgets\ActiveField

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
addAriaAttributes() Adds aria attributes to the input options. yii\widgets\ActiveField
addErrorClassIfNeeded() Adds validation class to the input options if needed. yii\widgets\ActiveField
addRoleAttributes() Add role attributes to the input options yii\widgets\ActiveField
adjustLabelFor() Adjusts the for attribute for the label based on the input options. yii\widgets\ActiveField
createLayoutConfig() yii\bootstrap5\ActiveField
getClientOptions() Returns the JS options for the field. yii\widgets\ActiveField
getInputId() Returns the HTML id of the input element of this form field. yii\widgets\ActiveField
isAjaxValidationEnabled() Checks if ajax validation enabled for the field. yii\widgets\ActiveField
isClientValidationEnabled() Checks if client validation enabled for the field. yii\widgets\ActiveField
renderLabelParts() yii\bootstrap5\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=\"form-check\">\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' => 'form-check-input'], 'labelOptions' => ['class' => ['widget' => 'form-check-label']]]
$checkTemplate public property

The template for checkboxes in default layout

public string $checkTemplate = "<div class=\"form-check\">\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

The default options for the error tags. The parameter passed to error() will be merged with this property when rendering the error tag. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().
  • encode: whether to encode the error output. Defaults to true.

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

public array $errorOptions = [
    'class' => 'invalid-feedback'
]
$hintOptions public property

The default options for the hint tags. The parameter passed to hint() will be merged with this property when rendering the hint tag. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().
public array $hintOptions = [
    'class' => ['widget' => 'form-text', 'text-muted'], 'tag' => 'div'
]
$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
public null|array $horizontalCssClasses = []
$inline public property

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

public boolean $inline = false
$inputOptions public property

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.

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

public array $inputOptions = [
    'class' => ['widget' => 'form-control']
]
$inputTemplate public property

Optional template to render the {input} placeholder content

public string|null $inputTemplate = null
$labelOptions public property

The default options for the label tags. The parameter passed to label() will be merged with this property when rendering the label tag.

public array $labelOptions = [
    'class' => ['widget' => 'form-label']
]
$options public property

The HTML attributes (name-value pairs) for the field container tag. The values will be HTML-encoded using yii\bootstrap5\Html::encode(). If a value is null, the corresponding attribute will not be rendered. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().

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

public array $options = [
    'class' => ['widget' => 'mb-3']
]
$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=\"form-check\">\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' => 'form-check-input'], 'labelOptions' => ['class' => ['widget' => 'form-check-label']]]
$radioTemplate public property (available since version 2.0.5)

The template for radios in default layout

public string $radioTemplate = "<div class=\"form-check\">\n{input}\n{label}\n{error}\n{hint}\n</div>"
$switchEnclosedTemplate public property

Tthe enclosed by label template for switches(custom checkboxes) in default layout

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

The template for switches (custom checkboxes) in horizontal layout

public string $switchHorizontalTemplate = "{beginWrapper}\n<div class=\"form-check form-switch\">\n{input}\n{label}\n{error}\n{hint}\n</div>\n{endWrapper}"
$switchTemplate public property

The template forswitches (custom checkboxes) in default layout

public string $switchTemplate = "<div class=\"form-check form-switch\">\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

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties
checkbox() public method

{@inheritdoc} Enable option switch to render as toggle switch.

See also https://getbootstrap.com/docs/5.1/forms/checks-radios/#switches.

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

Renders a list of checkboxes.

A checkbox list allows multiple selection, like listBox(). As a result, the corresponding submitted value is an array. The selection of the checkbox list is taken from the value of the model attribute.

public $this checkboxList ( $items, $options = [] )
$items array

The data item used to generate the checkboxes. The array values are the labels, while the array keys are the corresponding checkbox values.
$options array

Options (name => config) for the checkbox list. For the list of available options please refer to the $options parameter of yii\helpers\Html::activeCheckboxList().
return $this

The field object itself.
colorInput() public method

Renders a color picker (custom input).

See also https://getbootstrap.com/docs/5.1/forms/form-control/#color.

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

The tag options in terms of name-value pairs
createLayoutConfig() protected method

protected array createLayoutConfig ( array $instanceConfig )
$instanceConfig array

The configuration passed to this instance's constructor
return array

The layout specific default configuration for this instance

Renders a drop-down list.

The selection of the drop-down list is taken from the value of the model attribute.

public $this dropDownList ( $items, $options = [] )
$items array

The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using yii\helpers\ArrayHelper::map().

Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded.
$options array

The tag options in terms of name-value pairs.

For the list of available options please refer to the $options parameter of yii\helpers\Html::activeDropDownList().

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

The field object itself.
fileInput() public method

Renders a file input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

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

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\bootstrap5\Html::encode().

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

The field object itself.
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

Generates a label tag for $attribute.

public $this label ( $label = null, $options = [] )
$label string|null|false

The label to use. If null, the label will be generated via yii\base\Model::getAttributeLabel(). If false, the generated field will not contain the label part. Note that this will NOT be encoded.
$options array|null

The tag options in terms of name-value pairs. It will be merged with $labelOptions. The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\bootstrap5\Html::encode(). If a value is null, the corresponding attribute will not be rendered.
return $this

The field object itself.
listBox() public method

Renders a list box.

The selection of the list box is taken from the value of the model attribute.

public $this listBox ( $items, $options = [] )
$items array

The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using yii\helpers\ArrayHelper::map().

Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded.
$options array

The tag options in terms of name-value pairs.

For the list of available options please refer to the $options parameter of yii\helpers\Html::activeListBox().

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

The field object itself.
radio() public method

Renders a radio button.

This method will generate the checked tag attribute according to the model attribute value.

public $this radio ( $options = [], $enclosedByLabel = false )
$options array

The tag options in terms of name-value pairs. The following options are specially handled:

  • uncheck: string, the value associated with the uncheck state of the radio button. If not set, it will take the default value 0. This method will render a hidden input so that if the radio button is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. If you do not want any hidden input, you should explicitly set this option as null.
  • label: string, a label displayed next to the radio button. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should encode it to prevent XSS attacks. When this option is specified, the radio button will be enclosed by a label tag. If you do not want any label, you should explicitly set this option as null.
  • labelOptions: array, the HTML attributes for the label tag. This is only used when the label option is specified.

The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\bootstrap5\Html::encode(). If a value is null, the corresponding attribute will not be rendered.

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

Whether to enclose the radio within the label. If true, the method will still use $template to layout the radio button and the error message except that the radio is enclosed by the label tag.
return $this

The field object itself.
radioList() public method

Renders a list of radio buttons.

A radio button list is like a checkbox list, except that it only allows single selection. The selection of the radio buttons is taken from the value of the model attribute.

public $this radioList ( $items, $options = [] )
$items array

The data item used to generate the radio buttons. The array values are the labels, while the array keys are the corresponding radio values.
$options array

Options (name => config) for the radio button list. For the list of available options please refer to the $options parameter of yii\helpers\Html::activeRadioList().
return $this

The field object itself.
rangeInput() public method

Renders a range (custom input).

See also https://getbootstrap.com/docs/5.1/forms/range/.

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

The tag options in terms of name-value pairs:

  • 'min': min. value
  • 'max': max. value
  • 'step': range step, by default, 1
render() public method

Renders the whole field.

This method will generate the label, error tag, input tag and hint tag (if any), and assemble them into HTML according to $template.

public string render ( $content = null )
$content string|callable|null

The content within the field container. If null (not set), the default methods will be called to generate the label, error tag and input tag, and use them as the content. If a callable, it will be called to generate the content. The signature of the callable should be:

function ($field) {
    return $html;
}
return string

The rendering result.
renderLabelParts() protected method

protected void renderLabelParts ( \yii\bootstrap5\string $label = null, array $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/5.1/components/forms/#readonly-plain-text.

public $this staticControl ( array $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