Columns configuration Object is used by Grid Component as follows:
columns.js
SomeComponent.jsx
Columns list is specified as an object with column string IDs as keys and column configuration objects as values.
Notes:
sortCycle
is an array of string values,
which must be one of the “asc”, “desc” or “default”, where
“asc” stands for “ascending”,
“desc” stands for “descending”,
“default” means unsorted values(in order that data is passed from the model).
If you omit sortCycle property, sorting for the corresponding column
will be unavailable for the user. Else if you include the sortCycle
property
and pass an array there, the corresponding column will be available
for toggling sorting there: when the user will click on the column name
there will be toggled the sorting in the way of next sortCycle’s array itemeditor
property, there will be available
editing of fields in cells in the corresponding column for the user else
cells in the corresponding column will be unavailable for editing.parent
- Common headline for several columns. If specify this
property with the same value for several columns than headline
(<th> content) will be united into one with the value
specified in the field. E.g. you can add common headline ‘Full name’ for columns
name and surname, so that the columns will be separate,
but will have the common headline.sortField
- name of the sorting field(in model) for this column.
By default sortField==Column ID, but if there is several fields in one column
or the ‘column id’ doesn’t match any fields in model
you should specify which field the column will be sorted by.
E.g.: column ‘Full name’ consists of fields name
and surname
,
so you can specify that the column should be sorted by the surname
field.editorField
- name of the field(in model) which will be
edited in cells of this column. By default editorField==ColumnID,
but if there is several fields in one column or the ColumnID
doesn’t match any field in model you should use this property.onClickRefs
, corresponding HTML tags must have ref=”someRef” attributes
in markup returned by render
functions. Check out usage example here.