This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6626 from serhiyzhovnir/add-documentation-for-Col…
…umnsEditorRecord-UI-component Add documentation for the ColumnsEditorRecord UI component
- Loading branch information
Showing
3 changed files
with
98 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 94 additions & 0 deletions
94
src/guides/v2.3/ui_comp_guide/components/ui-columns-editor-record.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| group: ui-components-guide | ||
| title: ColumnsEditorRecord component | ||
| contributor_name: Atwix | ||
| contributor_link: https://www.atwix.com/ | ||
| --- | ||
|
|
||
| The ColumnsEditorRecord [UI component](https://glossary.magento.com/ui-component) is a container of record fields. The ColumnsEditorRecord should be used as a child of the [ColumnsEditor]({{ page.baseurl }}/ui_comp_guide/components/ui-columns-editor.html) component. | ||
|
|
||
| ## Configuration options | ||
|
|
||
| | Option | Description | Type | Default Value | | ||
| | --- | --- | --- | --- | | ||
| | `component` | The path to the component's `.js` file, relative to RequireJS. | String | `Magento_Ui/js/grid/editing/record` | | ||
| | `fieldTmpl` | The path to the component’s `.html` field template. | String | `'ui/grid/editing/field'` | | ||
| | `rowTmpl` | The path to the component’s `.html` row template. | String | `'ui/grid/editing/row'` | | ||
| | `templates`.`fields` | The object that contains the configurations for field types. | Object | `{base: {...},text: {...},date: {...},select: {...}}` | | ||
| | `templates`.`fields`.`base` | The base configurations of a record field. | Object | `{parent: '${ $.$data.record.name }',name: '${ $.$data.column.index }',provider: '${ $.$data.record.name }',dataScope: 'data.${ $.$data.column.index }',imports: {disabled: '${ $.$data.record.parentName }:fields.${ $.$data.column.index }.disabled'},isEditor: true}` | | ||
| | `templates`.`fields`.`date` | The date record field configurations. | Object | `{component: 'Magento_Ui/js/form/element/date',template: 'ui/form/element/date',dateFormat: 'MMM d, y h:mm:ss a'}` | | ||
| | `templates`.`fields`.`select` | The select record field configurations. | Object | `{component: 'Magento_Ui/js/form/element/select',template: 'ui/form/element/select',options: '${ JSON.stringify($.$data.column.options) }'}` | | ||
| | `templates`.`fields`.`text` | The text record field configurations. | Object | `{component: 'Magento_Ui/js/form/element/abstract',template: 'ui/form/element/input'}` | | ||
|
|
||
| ## Sources files | ||
|
|
||
| Extends [`UiCollection`]({{ page.baseurl }}/ui_comp_guide/concepts/ui_comp_uicollection_concept.html): | ||
|
|
||
| - [app/code/Magento/Ui/view/base/web/js/grid/editing/record.js]({{ site.mage2bloburl }}/{{page.guide_version}}/app/code/Magento/Ui/view/base/web/js/grid/editing/record.js) | ||
| - [app/code/Magento/Ui/view/base/web/templates/grid/editing/row.html]({{ site.mage2bloburl }}/{{page.guide_version}}/app/code/Magento/Ui/view/base/web/templates/grid/editing/row.html) | ||
| - [app/code/Magento/Ui/view/base/web/templates/grid/editing/field.html]({{ site.mage2bloburl }}/{{page.guide_version}}/app/code/Magento/Ui/view/base/web/templates/grid/editing/field.html) | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Integrate the ColumnsEditorRecord component with the ColumnsEditor component | ||
|
|
||
| This is an example of how the ColumnsEditorRecord component integrates with the [ColumnsEditor]({{ site.mage2bloburl }}/{{page.guide_version}}/app/code/Magento/Ui/view/base/web/js/grid/editing/editor.js) component: | ||
|
|
||
| ```xml | ||
| <listing> | ||
| ... | ||
| <columns name="columns"> | ||
| <settings> | ||
| <editorConfig> | ||
| <param name="templates" xsi:type="array"> | ||
| <item name="record" xsi:type="array"> | ||
| <item name="component" xsi:type="string">Magento_Ui/js/grid/editing/record</item> | ||
| <item name="fieldTmpl" xsi:type="string">ui/grid/editing/field</item> | ||
| <item name="rowTmpl" xsi:type="string">ui/grid/editing/row</item> | ||
| </item> | ||
| </param> | ||
| <param name="enabled" xsi:type="boolean">true</param> | ||
| </editorConfig> | ||
| </settings> | ||
| <selectionsColumn name="ids"> | ||
| <settings> | ||
| <indexField>entity_id</indexField> | ||
| </settings> | ||
| </selectionsColumn> | ||
| <column name="entity_id"> | ||
| <settings> | ||
| <label translate="true">ID</label> | ||
| </settings> | ||
| </column> | ||
| <column name="title"> | ||
| <settings> | ||
| <filter>text</filter> | ||
| <editor> | ||
| <validation> | ||
| <rule name="required-entry" xsi:type="boolean">true</rule> | ||
| </validation> | ||
| <editorType>text</editorType> | ||
| </editor> | ||
| <label translate="true">Title</label> | ||
| </settings> | ||
| </column> | ||
| <column name="is_active" component="Magento_Ui/js/grid/columns/select"> | ||
| <settings> | ||
| <options class="Magento\Config\Model\Config\Source\Yesno"/> | ||
| <filter>select</filter> | ||
| <editor> | ||
| <editorType>select</editorType> | ||
| </editor> | ||
| <dataType>select</dataType> | ||
| <label translate="true">Status</label> | ||
| </settings> | ||
| </column> | ||
| ... | ||
| </columns> | ||
| </listing> | ||
| ``` | ||
|
|
||
| #### Result | ||
|
|
||
|  | ||
|
|