DynamicRows component

Edit on GitHub
Log an Issue

The DynamicRows component is a dynamic collection of records. The user can edit the records, change their position, and navigate through the collection.

Configuration options

Option Description Type Default
addButton Renders button for adding a new row. Boolean -
addButtonLabel Label for the adding a new row button. String 'Add'
additionalClasses Sets custom classes to the component’s DOM block. Object {}
defaultRecord Renders the default (first) row when the component is initialized without data. Boolean false
deleteProperty The property added to a record data object when the record is deleted. Applied if the deleteValue option is enabled. String 'delete'
dndConfig Configuration of the drag and drop (DND) plugin for dynamicRows. Object {name: '${ $.name }_dnd', component: 'Magento_Ui/js/dynamic-rows/dnd', template: 'ui/dynamic-rows/cells/dnd', recordsProvider: '${ $.name }', enabled: true }
collapsibleHeader Enables or disables the collapsible functionality for the header (if columns header is enabled). Boolean false
columnsHeader Hides or shows columns header. Boolean true
columnsHeaderClasses Adds custom class to columns header (if the column header is enabled). String ''
component The path to the component’s JS constructor in terms of RequireJS. String Magento_Ui/js/dynamic-rows/dynamic-rows
currentPage The number of current page. Number 1
deleteValue Adds the deleteProperty property in the data object for the deleted record. Boolean false
disabled Initial component’s state. When set to true, users cannot take action on the element. Boolean false
fallbackResetTpl The path to the fallback reset (restore to default button) .html template. String ui/form/element/helper/fallback-reset-link
identificationProperty The identification property added to the record data object. String record_id
pageSize The number of records on one page. Number 20
recordTemplate The path to the .html template of a records(row). The list of templates is declared in the templates property. String record
template The path to the component’s .html template. String ui/dynamic-rows/templates/default
visible Initial component’s visibility. When set to false, the display: none CSS style is added to the component’s DOM block. Boolean true

Source files

Extends UiCollection:

Examples

Integrate the DynamicRows component with the Form component

This is an example of how the DynamicRows component integrates with the Form component:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

<form>
    ...
    <dynamicRows name="dynamic_rows">
        <settings>
            <addButtonLabel translate="true">Add Record</addButtonLabel>
            <additionalClasses>
                <class name="admin__field-wide">true</class>
            </additionalClasses>
            <componentType>dynamicRows</componentType>
        </settings>
        <container name="record" component="Magento_Ui/js/dynamic-rows/record">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="isTemplate" xsi:type="boolean">true</item>
                    <item name="is_collection" xsi:type="boolean">true</item>
                    <item name="componentType" xsi:type="string">container</item>
                </item>
            </argument>
            <field name="field_1" formElement="input">
                <argument name="data" xsi:type="array">
                    <item name="config" xsi:type="array">
                        <item name="fit" xsi:type="boolean">false</item>
                    </item>
                </argument>
                <settings>
                    <validation>
                        <rule name="required-entry" xsi:type="boolean">true</rule>
                    </validation>
                    <dataType>text</dataType>
                    <label>Field #1</label>
                </settings>
            </field>
            <field name="field_2" formElement="input">
                <argument name="data" xsi:type="array">
                    <item name="config" xsi:type="array">
                        <item name="fit" xsi:type="boolean">false</item>
                    </item>
                </argument>
                <settings>
                    <validation>
                        <rule name="required-entry" xsi:type="boolean">true</rule>
                    </validation>
                    <dataType>text</dataType>
                    <label>Field #2</label>
                </settings>
            </field>
        </container>
    </dynamicRows>
</form>

Result

DynamicRows Component example

© 2021 Magento. All rights reserved.