Skip to content

Latest commit

 

History

History
235 lines (188 loc) · 9.26 KB

ui-form.md

File metadata and controls

235 lines (188 loc) · 9.26 KB
layout group subgroup title menu_title version github_link
default
UI_Components_guide
components
Form component
Form component
2.1
ui_comp_guide/components/ui-form.md

Overview

Form component allows performing CRUD operations on an entity.

The following is the Form component constructor: form.js

Related UI components

The following components are used to extend the Form component:

  • DataSource
  • FieldSet
  • Field
  • Layout
  • Container

Component options

  • js_config -> deps - sets the dependency on component initialization

  • js_config -> config -> provider - specifies the name of the component data

  • layout - configuration class meets the visualization component (See examples in 'Configuring' section)

Create an instance of the Form component

To create an instance of the Form component, you need to do the following:

  1. In you custom module, add a configuration file for the instance, for example: customer_form.xml.
  2. Add a set of fields (the Fieldset component with the component of the Field) for entity or to implement the upload of meta info in the DataProvider.
  3. Create the DataProvider class for the entity that implements DataProviderInterface
  • Add a component in Magento layout as a node: <uiComponent name="customer_form"/>

Example:

{% highlight xml %} ... {% endhighlight %}

Configure the Form component

Component could be configured in two ways:

  • globally: using any module's view/ui_component/etc/definition.xml file. All settings declared in this file will be applied to all component's instances
  • locally: using concrete component instance configuration, such as <your module root dir>/Magento/Customer/view/base/ui_component/customer_form

Create configuration file: <your module root dir>/Magento/Customer/view/base/ui_component/customer_form.xml

{% highlight xml%}

customer_form.customer_form_data_source customer_form.customer_form_data_source Customer Information tabs left ... {% endhighlight%}

Nodes are optional and contain parameters required for component:

  • js_config -> deps - sets the dependency on component initialization

  • js_config -> config -> provider - specifies the name of the component data

  • layout - configuration class meets the visualization component. Names for deps and provider are specified with a complete path from the root component with the separator "."

Add a description of the fields in the form using components and Field Fieldset:

{%highlight xml%} ...

Account Information false text input customer … {% endhighlight%}

To group components you can use the component container as in example below:

{% highlight xml%} group Magento_Ui/js/form/components/group Group true false 20 ... ... {% endhighlight %}

Creating DataSource

You need to configure component's DataSource in order to provide data and meta information for your Form component.

DataSource aggregates an object of class implements the interface \Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface

An example of the configuration of the DataSource object:

{% highlight xml%}

... Magento\Customer\Model\Customer\DataProvider entity_id id Account Information true Addresses Magento_Ui/js/grid/provider customer/index/save customer/index/validate Magento_Ui/js/form/provider {% endhighlight %}

Component configuration:

  • argument "dataProvider" - contains configuration, class name and arguments

  • js_config -> component - > JS indication of a responsible component

Data provided by data source is shared and available for all components in the Assembly (in this case for all child components of UI Form).

Data Source is another UI Component that provides data in specific format which is shared among all UI Components.

Replacing

Replacing principles are the same for all UI Components.

Global replacement

To replace all instances of a UI Form with a custom implementation redefine link to a constructor in definition.xml.

app/code/Magento/Ui/view/base/ui_component/etc/definition.xml

{% highlight xml%}

Magento_Ui/js/form/customFormConstructor {% endhighlight %}

Instance Replacement

To replace one instance of a UI Form Component redefine link to a constructor in your module's form configuration file:

app/code/Magento/Customer/view/base/ui_component/customer_form.xml

{% highlight xml%}

Magento_Customer/js/form/customFormConstructor {% endhighlight %}