dashboard/docusaurus/docs/extensions/api/table-columns.md

Table Columns

Table Columns are added to Rancher via the addTableColumn method.

addTableColumn

(Rancher version v2.7.2)

IMPORTANT NOTE: on Rancher version v2.8.0 we've introduced breaking changes to the behaviour of this extension enhancement (Table Columns). Previously, you would target the resource name of the table you were trying to extend, which was different from the usage of the LocationConfig object in any of the other extension enhancements available. With these new changes, the LocationConfig object will be used to target a specific page that contains a table and add it to that particular one, therefore having a better control of the new table column appearance.

This method adds a table column to a ResourceTable element-based table on the UI.

Method:

plugin.addTableColumn(where: String, when: LocationConfig, column: TableColumn);

Arguments

where string parameter admissible values for this method:

Key	Type	Description
TableColumnLocation.RESOURCE	String	Location for a table column on a Resource List View page

when Object admissible values:

LocationConfig as described above for the LocationConfig object.

(Rancher version v2.13.0)

An addition parameter can be provided which will be used to support the column when server-side pagination is enabled. For more information and other changes required to server-side pagination see here.

plugin.addTableColumn(where: String, when: LocationConfig, column: TableColumn, paginationColumn?: PaginationTableColumn));

TableColumnLocation.RESOURCE column

column config object. Admissible parameters for the column with 'TableColumnLocation.RESOURCE' are:

Key	Type	Description
name	String	Label for column
labelKey	String	Same as "name" but allows for translation. Will supersede "name"
value	String	Object property to obtain the value from
getValue	Function	Same as "value", but it can be a function. Will supersede "value"
width	Int	Column width (in px). Optional
sort	boolean,string,Array	Object properties to be bound to the table sorting. Optional
search	boolean,string,Array	Object properties to be bound to the table search. Optional
formatter	string	Name of a formatter component used to render the cell. Components should be in the extension formatters folder
formatterOpts	any	Provide additional values to the formatter component via a formatterOpts component param

Usage example for 'TableColumnLocation.RESOURCE':

plugin.addTableColumn(
  TableColumnLocation.RESOURCE,
  { resource: ['configmap'] },
  {
    name:     'some-prop-col',
    labelKey: 'generic.comingSoon',
    getValue: (row: any) => {
      return `${ row.id }-DEMO-COL-STRING-ADDED!`;
    },
    width: 100,
    sort: ['stateSort', 'nameSort'],
    search: ['stateSort', 'nameSort'],
  }
);