Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

magento/devdocs#: Extend information about "Input component" #4956

Merged
merged 5 commits into from
Jul 16, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions guides/v2.2/ui_comp_guide/components/ui-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,14 @@ The Input component implements the [HTML](https://glossary.magento.com/html) `<i

## Configuration options

<table>
<tr>
<th>Option </th>
<th>Description</th>
<th>Type</th>
<th>Default</th>
</tr>
<tr>
<td><code>component</code></td>
<td>The path to the component’s <code>.js</code> file in terms of RequireJS.</td>
<td>String</td>
<td><code>Magento_Ui/js/form/element/abstract</code></td>
</tr>
<tr>
<td><code>template</code></td>
<td>The path to the component’s <code>.html</code> template.</td>
<td>String</td>
<td><code>ui/form/field</code></td>
</tr>
</table>
|Option|Description|Type|Default|
|--- |--- |--- |--- |
|`class`|Path to the PHP class responsible for the backend implementation of the component.|String| - |
|`component`|The path to the component’s `.js` file in terms of RequireJS.|String|`Magento_Ui/js/form/element/abstract`|
|`displayArea`|Renders the component in the location that was declared in the layout.|String| `body` |
|`extends`|Extends configuration from specified component.|String| - |
|`formElement`|Form Element.|`hidden`, `file`, `input`, `date`, `boolean`, `checkbox`, `checkboxset`, `email`, `select`, `multiselect`, `text`, `textarea`, `price`, `radioset`, `wysiwyg`|`input`|
|`name`|Element's index in the scope of the current collection that will be used to build its unique identifier.|String| - |
|`provider`|Reference to component data provider. For example, for the "New Customer" page on the back-end side it will be equal to `customer_form.customer_form_data_source` |String| - |
|`sortOrder`|Element's position in the collection|Int| `0` |
|`template`|The path to the component’s `.html` template.|String|`ui/form/field`|