Vue Form API

Specifies the shortcut key that sets focus on the UI component.

Specifies whether the UI component changes its state as a result of user interaction.

Specifies whether all item labels are aligned. Applies only to labels outside their editors (see labelMode).

Specifies whether item labels in all groups are aligned. Applies only to labels outside their editors (see labelMode).

The count of columns in the form layout.

Specifies dependency between the screen factor and the count of columns in the form layout.

Specifies a function that customizes a form item after it has been created.

Specifies whether the UI component responds to user interaction.

Specifies the global attributes to be attached to the UI component's container element.

Specifies whether the UI component can be focused using keyboard navigation.

Provides the Form's data. Gets updated every time form fields change.

Specifies the UI component's height.

Specifies text for a hint that appears when a user pauses on the UI component.

Specifies whether the UI component changes its state when a user pauses on it.

Holds an array of form items.

Specifies the location of a label against the editor. Applies only to labels outside their editors (see labelMode).

Specifies a display mode for item labels.

The minimum column width used for calculating column count in the form layout. Applies only if colCount property is "auto".

A function that is executed when the UI component is rendered and each time the component is repainted.

A function that is executed before the UI component is disposed of.

A function that is executed when the Enter key has been pressed while an editor is focused.

A function that is executed when the value of a formData object field is changed.

A function used in JavaScript frameworks to save the UI component instance.

A function that is executed after a UI component property is changed.

The text displayed for optional fields. Applies only if showOptionalMark is true.

Specifies whether all editors on the form are read-only. Applies only to non-templated items.

The text displayed for required fields.

Specifies the message that is shown for end-users if a required field value is not specified.

Switches the UI component to a right-to-left representation.

Specifies a function that categorizes screens by their width.

A Boolean value specifying whether to enable or disable form scrolling.

Specifies whether a colon is displayed at the end of form labels. Applies only to labels outside their editors (see labelMode).

Specifies whether or not the optional mark is displayed for optional fields.

Specifies whether or not the required mark is displayed for required fields.

Specifies whether or not the total validation summary is displayed on the form.

Specifies the number of the element when the Tab key is used for navigating.

Gives a name to the internal validation group.

Specifies whether the UI component is visible.

Specifies the UI component's width.

Prevents the UI component from refreshing until the endUpdate() method is called.

Specifies the device-dependent default configuration properties for this component.

Disposes of all the resources allocated to the Form instance.

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

Sets focus on the UI component.

Gets a button's instance.

Gets an editor instance. Takes effect only if the form item is visible.

Gets the instance of a UI component found using its DOM node.

Gets the UI component's instance. Use it to access other methods of the UI component.

Gets a form item's configuration.

Updates the values of several item properties.

Updates the value of a single item option.

Detaches all event handlers from a single event.

Detaches a particular event handler from a single event.

Subscribes to an event.

Subscribes to events.

Gets all UI component properties.

Gets the value of a single property.

Updates the value of a single property.

Updates the values of several properties.

Registers a handler to be executed when a user presses a specific key.

Repaints the UI component without reloading data. Call it to update the UI component's markup.

Resets a property to its default value.

Resets the editor's value to undefined.

Merges the passed data object with formData. Matching properties in formData are overwritten and new properties added.

Updates a formData field and the corresponding editor.

Updates the dimensions of the UI component contents.

Validates the values of all editors on the form against the list of the validation rules specified for each form item.

Raised when the UI component's content is ready.

Raised before the UI component is disposed of.

Raised when the Enter key has been pressed while an editor is focused.

Raised when the value of a formData object field is changed.

Raised only once, after the UI component is initialized.

Raised after a UI component property is changed.

Configures a button form item.

This article describes configuration properties of an empty form item.

This article describes configuration properties of a group form item.

This article describes configuration properties of a simple form item.

This article describes configuration properties of a tabbed form item.