ActiveForm

API reference › Bootstrap 6 › ActiveForm

class	`yii2\extensions\bootstrap6\ActiveForm`
Extends	`yii\widgets\ActiveForm` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Source	`src/ActiveForm.php`

Renders a Bootstrap 6 form with default, horizontal, inline, or floating-label field layouts.

The layout selects the default ActiveField configuration; override it per form through $fieldConfig. The inline layout adds row lg:row-cols-auto g-3 align-items-center to the form, and $nativeValidation opts the form in to the Bootstrap :user-invalid styling with the data-bs-validate attribute.

Properties

Property	Type	Description	Defined by
`$action`	`array\|string`	The form action URL. Default: `''`.	`yii\widgets\ActiveForm`
`$ajaxDataType`	`string`	The type of data that you’re expecting back from the server. Default: `'json'`.	`yii\widgets\ActiveForm`
`$ajaxParam`	`string`	The name of the GET parameter indicating the validation request is an AJAX request. Default: `'ajax'`.	`yii\widgets\ActiveForm`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientScript`	`array\|yii\web\client\ClientScriptInterface\|null`	Client script class to use for client-side validation. Default: `null`.	`yii\widgets\ActiveForm`
`$enableAjaxValidation`	`bool`	Whether to enable AJAX-based data validation. Default: `false`.	`yii\widgets\ActiveForm`
`$enableClientScript`	`bool`	Whether to hook up `yii.activeForm` JavaScript plugin. Default: `true`.	`yii\widgets\ActiveForm`
`$enableClientValidation`	`bool`	Whether to enable client-side data validation. Default: `true`.	`yii\widgets\ActiveForm`
`$encodeErrorSummary`	`bool`	Whether to perform encoding on the error summary. Default: `true`.	`yii\widgets\ActiveForm`
`$errorCssClass`	`string`	CSS class added to the control when the attribute has validation errors. Default: `'is-invalid'`.	`ActiveForm`
`$errorSummaryCssClass`	`string`	CSS class of the error summary container. Default: `'alert theme-danger'`.	`ActiveForm`
`$fieldClass`	`string`	Field class used by `field()`; it must extend `ActiveField`. Default: `\yii2\extensions\bootstrap6\ActiveField::class`.	`ActiveForm`
`$fieldConfig`	`array\|Closure`	The default configuration used by `field()` when creating a new field object. Default: `[]`.	`yii\widgets\ActiveForm`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$layout`	`string`	Form layout, one of the `LAYOUT_*` constants. Default: `self::LAYOUT_DEFAULT`.	`ActiveForm`
`$method`	`string`	The form submission method. Default: `'post'`.	`yii\widgets\ActiveForm`
`$nativeValidation`	`bool\|string\|null`	Client-side validation styling: `true` renders `data-bs-validate`, `'valid'` renders `data-bs-validate="valid"` (success styling too), `false` removes the attribute, and `null` keeps `$options` unchanged. Default: `null`.	`ActiveForm`
`$options`	`array`	The HTML attributes (name-value pairs) for the form tag. Default: `[]`.	`yii\widgets\ActiveForm`
`$requiredCssClass`	`string`	The CSS class that is added to a field container when the associated attribute is required. Default: `'required'`.	`yii\widgets\ActiveForm`
`$scrollToError`	`bool`	Whether to scroll to the first error after validation. Default: `true`. Available since 2.0.6.	`yii\widgets\ActiveForm`
`$scrollToErrorOffset`	`int`	Offset in pixels that should be added when scrolling to the first error. Default: `0`. Available since 2.0.11.	`yii\widgets\ActiveForm`
`$successCssClass`	`string`	CSS class added to the control when the attribute passes validation. Default: `'is-valid'`.	`ActiveForm`
`$validateOnBlur`	`bool`	Whether to perform validation when an input field loses focus. Default: `true`.	`yii\widgets\ActiveForm`
`$validateOnChange`	`bool`	Whether to perform validation when the value of an input field is changed. Default: `true`.	`yii\widgets\ActiveForm`
`$validateOnSubmit`	`bool`	Whether to perform validation when the form is submitted. Default: `true`.	`yii\widgets\ActiveForm`
`$validateOnType`	`bool`	Whether to perform validation while the user is typing in an input field. Default: `false`.	`yii\widgets\ActiveForm`
`$validatingCssClass`	`string`	The CSS class that is added to a field container when the associated attribute is being validated. Default: `'validating'`.	`yii\widgets\ActiveForm`
`$validationDelay`	`int`	Number of milliseconds that the validation should be delayed when the user types in the field and `$validateOnType` is set `true`. Default: `500`.	`yii\widgets\ActiveForm`
`$validationStateOn`	`string`	Element that receives the validation CSS classes; Bootstrap styles the control itself. Default: `self::VALIDATION_STATE_ON_INPUT`.	`ActiveForm`
`$validationUrl`	`array\|string\|null`	The URL for performing AJAX-based validation. Default: `null`.	`yii\widgets\ActiveForm`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`afterRun()`	This method is invoked right after a widget is executed.	`yii\base\Widget`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	Begins a widget.	`yii\base\Widget`
`beginField()`	Begins a form field.	`yii\widgets\ActiveForm`
`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`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`end()` static	Ends a widget.	`yii\base\Widget`
`endField()`	Ends a form field.	`yii\widgets\ActiveForm`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`errorSummary()`	Generates a summary of the validation errors.	`yii\widgets\ActiveForm`
`field()`		`ActiveForm`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getId()`	Returns the ID of the widget.	`yii\base\Widget`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`getViewPath()`	Returns the directory containing the view files for this widget.	`yii\base\Widget`
`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`
`init()`		`ActiveForm`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`registerClientScript()`	This registers the necessary JavaScript code.	`yii\widgets\ActiveForm`
`render()`	Renders a view.	`yii\base\Widget`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`run()`	Runs the widget.	`yii\widgets\ActiveForm`
`setId()`	Sets the ID of the widget.	`yii\base\Widget`
`setView()`	Sets the view object to be used by this widget.	`yii\base\Widget`
`trigger()`	Triggers an event.	`yii\base\Component`
`validate()` static	Validates one or several models and returns an error message array indexed by the attribute IDs.	`yii\widgets\ActiveForm`
`validateMultiple()` static	Validates an array of model instances and returns an error message array indexed by the attribute IDs.	`yii\widgets\ActiveForm`
`widget()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`getClientOptions()` protected		`yii\widgets\ActiveForm`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Constants

Constant	Value	Description	Defined by
`LAYOUT_DEFAULT`	`'default'`	Stacked labels, controls, hints, and feedback.	`ActiveForm`
`LAYOUT_FLOATING`	`'floating'`	Floating labels rendered inside a `.form-floating` wrapper.	`ActiveForm`
`LAYOUT_HORIZONTAL`	`'horizontal'`	Grid rows with the label and the control side by side.	`ActiveForm`
`LAYOUT_INLINE`	`'inline'`	Auto-sized columns with visually hidden labels and no error feedback.	`ActiveForm`
`LAYOUTS`	`[self::LAYOUT_DEFAULT, self::LAYOUT_HORIZONTAL, self::LAYOUT_INLINE, self::LAYOUT_FLOATING]`	Supported layouts.	`ActiveForm`
`VALIDATION_STATE_ON_CONTAINER`	`'container'`	Add validation state class to container tag Available since 2.0.14.	`yii\widgets\ActiveForm`
`VALIDATION_STATE_ON_INPUT`	`'input'`	Add validation state class to input tag Available since 2.0.14.	`yii\widgets\ActiveForm`

Method details

field()

public function field(yii\base\Model $model, string $attribute, mixed[] $options = []): yii2\extensions\bootstrap6\ActiveField

Parameters

Parameter	Type	Description
`$model`	`yii\base\Model`	Model holding the attribute.
`$attribute`	`string`	Attribute name or expression.
`$options`	`mixed[]`	Field configuration merged over `$fieldConfig`.

Returns

ActiveField

Throws

yii\base\InvalidConfigException: if the configured field class does not extend ActiveField.

init()

public function init(): void

Throws

yii\base\InvalidConfigException: if $layout or $nativeValidation is invalid.