ColumnsControls component

The ColumnsControls component is a collection of columns. It provides an interface for showing and hiding columns. The interface contains:

• The total number of all available columns in a grid.
• The number of columns currently active/displayed.

Configuration options

Source files

Extends uiCollection:

• app/code/Magento/Ui/view/base/web/js/grid/controls/columns.js
• app/code/Magento/Ui/view/base/web/templates/grid/controls/columns.html

Examples

Add ColumnsControls component to Listing basic component

1
2
3
4
5
6
7
8
9
10
11
12
13
<listing>
    ...
    <listingToolbar>
        ...
         <columnsControls name="columns_controls">
            <setting>
                <minVisible>1</minVisible>
                <maxVisible>3</maxVisible>
            </setting>
         </columnsControls>
    </listingToolbar>
    ...
</listing>

Result