Column component
The Column component implements a basic column in Listing.
Configuration options
| Option | Description | Type | Default |
|---|---|---|---|
component |
The path to the component’s .js file in terms of RequireJS. |
String | Magento_Ui/js/grid/columns/column |
bodyTmpl |
Path to the template used for rendering column's fields in the table's body. | String | ui/grid/cells/text |
controlVisibility |
Whether a user can control column's visibility handled by the ColumnsControls component. | Boolean | true |
disableAction |
Disables the action set in the templates.fieldAction property. |
Boolean | false |
draggable |
Defines if a user can change column's position in the table by grabbing column's header and dragging it across the table. | Boolean | true |
editor |
String | Object | ||
fieldClass |
Additional CSS classes added to the column's field elements. | {[name: String]: Boolean} | '' |
filter |
Reference to one of the available filter types defined in the Filters component. If the value represents an object containing the filterType field, this object is considered as an extension of the referenced filter element. If there's no such field in the value object, it is considered as a definition of a custom filter element. |
String | Object | |
headerTmpl |
Path to the .html template for the column's header. |
String | ui/grid/columns/text |
label |
The column label displayed in the header. | String | '' |
sortable |
Whether column's fields can be used to sort records in a table. | Boolean | true |
sorting |
Column's sorting order. Can be ascending (asc), descending (desc) or none (false). Setting sorting to false does not disable sorting, which is defined by the sortable option. |
asc | desc | Boolean |
false |
statefull |
Defined in the parent uiElement class. | {visible: true, sorting: true} |
|
templates.fieldAction |
The action performed on the column's field click. | ColumnAction | - |
visible |
Initial component's visibility. When set to false, the display: none CSS style is added to the component's DOM block. |
Boolean | true |
ColumnAction interface
| Option | Description | Type | Required |
|---|---|---|---|
params |
A list of arguments that will be passed to the method. | Array | Optional |
provider |
Reference to component. | String | Required |
target |
Name of the component's method to be invoked. | String | Required |
Source files
Extends UiElement:
