PHP 7.3 reached end of support in December 2021 and Adobe Commerce 2.3.x reaches end of support in September 2022. You may want to consider planning your upgrade now to Adobe Commerce 2.4.x and PHP 7.4.x to help maintain PCI compliance.

ColumnsEditingClient component

The ColumnsEditingClient UI component is an extension for the ColumnsEditor component. It provides functionality for saving edited data.

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/client
requestConfig The request configuration for AJAX. Object {dataType: 'json',type: 'POST'}
saveUrl Path to a controller that will process the data saving request. String -
validateBeforeSave Defines whether validation executes before data saving. Boolean true
validateUrl Path to a controller that will process the data validation request. String -

Sources files

Extends uiClass:

Examples

Integrate the ColumnsEditingClient component with the ColumnsEditor component

This is an example of how the ColumnsEditingClient component integrates with the ColumnsEditor component:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<listing>
    ...
    <columns name="columns">
        <settings>
            <editorConfig>
                <param name="clientConfig" xsi:type="array">
                    <item name="saveUrl" xsi:type="url" path="path/to/saveController"/>
                    <item name="validateUrl" xsi:type="url" path="path/to/validateController"/>
                    <item name="validateBeforeSave" xsi:type="boolean">true</item>
                </param>
                <param name="enabled" xsi:type="boolean">true</param>
            </editorConfig>
        </settings>
        ...
    </columns>
</listing>

Disable validation before saving data

This is an example of how to disable validation before saving data:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<listing>
    ...
    <columns name="columns">
        <settings>
            <editorConfig>
                <param name="clientConfig" xsi:type="array">
                    <item name="saveUrl" xsi:type="url" path="path/to/saveController"/>
                    <item name="validateBeforeSave" xsi:type="boolean">false</item>
                </param>
                <param name="enabled" xsi:type="boolean">true</param>
            </editorConfig>
        </settings>
        ...
    </columns>
</listing>