Skip to content

Interface: AdditionalCategoryColumnRegistration#

Renderer.Component.AdditionalCategoryColumnRegistration

This is the type used to declare new catalog category columns

Hierarchy#

AdditionalCategoryColumnRegistration

Table of contents#

Properties#

Methods#

Properties#

group#

group: string

The catalog entity group that is declared by the category for this registration

e.g. - "entity.k8slens.dev"


id#

id: string

This value MUST to be unique to your extension

Inherited from#

CategoryColumnRegistration.id


kind#

kind: string

The catalog entity kind that is declared by the category for this registration

e.g. - "KubernetesCluster"


priority#

Optional priority: number

The sorting order value.

default 50

Inherited from#

CategoryColumnRegistration.priority


titleProps#

titleProps: TitleCellProps

This function will be used to generate the columns title cell.

Inherited from#

CategoryColumnRegistration.titleProps

Methods#

renderCell#

renderCell(entity): ReactNode

This function will be called to generate the cells (on demand) for the column

Parameters#

Name Type
entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

Returns#

ReactNode

Inherited from#

CategoryColumnRegistration.renderCell


searchFilter#

Optional searchFilter(entity): string | string[]

If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.

Parameters#

Name Type
entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

Returns#

string | string[]

Inherited from#

CategoryColumnRegistration.searchFilter


sortCallback#

Optional sortCallback(entity): string | number | (string | number)[]

If provided then the column will support sorting and this function will be called to determine a row's ordering.

strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.

Parameters#

Name Type
entity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>

Returns#

string | number | (string | number)[]

Inherited from#

CategoryColumnRegistration.sortCallback