Skip to content

@k8slens/extensions / Exports / Renderer / Component / KubeObjectListLayoutProps

Interface: KubeObjectListLayoutProps<K, A, D>#

Renderer.Component.KubeObjectListLayoutProps

Type parameters#

Name Type
K extends KubeObject
A extends KubeApi<K, D>
D extends KubeJsonApiDataFor<K>

Hierarchy#

  • Omit<ItemListLayoutProps<K, false>, "getItems" | "dependentStores" | "preloadStores">

↳ KubeObjectListLayoutProps

Table of contents#

Properties#

Properties#

addRemoveButtons#

• Optional addRemoveButtons: Partial<AddRemoveButtonsProps>

Inherited from#

Omit.addRemoveButtons

className#

• className: IClassName

Inherited from#

Omit.className

columns#

• Optional columns: SpecificKubeListLayoutColumn<K>[]

copyClassNameFromHeadCells#

• Optional copyClassNameFromHeadCells: boolean

Inherited from#

Omit.copyClassNameFromHeadCells

customizeHeader#

• Optional customizeHeader: HeaderCustomizer | HeaderCustomizer[]

Inherited from#

Omit.customizeHeader

customizeRemoveDialog#

• Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>

Type declaration#

▸ (selectedItems): Partial<ConfirmDialogParams>

Parameters#
Name Type
selectedItems K[]
Returns#

Partial<ConfirmDialogParams>

Inherited from#

Omit.customizeRemoveDialog

customizeTableRowProps#

• Optional customizeTableRowProps: (item: K) => Partial<TableRowProps<K>>

Type declaration#

▸ (item): Partial<TableRowProps<K>>

Parameters#
Name Type
item K
Returns#

Partial<TableRowProps<K>>

Inherited from#

Omit.customizeTableRowProps

data-testid#

• Optional data-testid: string

Inherited from#

Omit.data-testid

dependentStores#

• Optional dependentStores: SubscribableStore[]

detailsItem#

• Optional detailsItem: K

Inherited from#

Omit.detailsItem

failedToLoadMessage#

• Optional failedToLoadMessage: StrictReactNode

Message to display when a store failed to load

Default

"Failed to load items"

Inherited from#

Omit.failedToLoadMessage

filterCallbacks#

• Optional filterCallbacks: ItemsFilters<K>

Inherited from#

Omit.filterCallbacks

filterItems#

• Optional filterItems: ItemsFilter<K>[]

Deprecated

Inherited from#

Omit.filterItems

getItems#

• Optional getItems: () => K[]

Type declaration#

▸ (): K[]

Returns#

K[]

hasDetailsView#

• Optional hasDetailsView: boolean

Inherited from#

Omit.hasDetailsView

headerClassName#

• Optional headerClassName: IClassName

Inherited from#

Omit.headerClassName

hideFilters#

• Optional hideFilters: boolean

Inherited from#

Omit.hideFilters

isConfigurable#

• Optional isConfigurable: boolean

Inherited from#

Omit.isConfigurable

isReady#

• Optional isReady: boolean

Inherited from#

Omit.isReady

isSelectable#

• Optional isSelectable: boolean

Inherited from#

Omit.isSelectable

items#

• Optional items: K[]

onDetails#

• Optional onDetails: (item: K) => void

Type declaration#

▸ (item): void

Parameters#
Name Type
item K
Returns#

void

Inherited from#

Omit.onDetails

renderFooter#

• Optional renderFooter: (parent: NonInjectedItemListLayout<K, false>) => StrictReactNode

Type declaration#

▸ (parent): StrictReactNode

Parameters#
Name Type
parent NonInjectedItemListLayout<K, false>
Returns#

StrictReactNode

Inherited from#

Omit.renderFooter

renderHeaderTitle#

• Optional renderHeaderTitle: RenderHeaderTitle<K, false>

Inherited from#

Omit.renderHeaderTitle

renderItemMenu#

• Optional renderItemMenu: (item: K, store: ItemListStore<K, false>) => StrictReactNode

Type declaration#

▸ (item, store): StrictReactNode

Parameters#
Name Type
item K
store ItemListStore<K, false>
Returns#

StrictReactNode

Inherited from#

Omit.renderItemMenu

renderTableContents#

• renderTableContents: (item: K) => (StrictReactNode | TableCellProps)[]

Type declaration#

▸ (item): (StrictReactNode | TableCellProps)[]

Parameters#
Name Type
item K
Returns#

(StrictReactNode | TableCellProps)[]

Inherited from#

Omit.renderTableContents

renderTableHeader#

• Optional renderTableHeader: (undefined | null | TableCellProps)[]

Inherited from#

Omit.renderTableHeader

resourceName#

• Optional resourceName: string

Customize resource name for e.g. search input ("Search ..."") If not provided, ResourceNames is used instead with a fallback to resource kind.

searchFilters#

• Optional searchFilters: SearchFilter<K>[]

Inherited from#

Omit.searchFilters

showHeader#

• Optional showHeader: boolean

Inherited from#

Omit.showHeader

sortingCallbacks#

• Optional sortingCallbacks: TableSortCallbacks<K>

Inherited from#

Omit.sortingCallbacks

spinnerTestId#

• Optional spinnerTestId: string

Inherited from#

Omit.spinnerTestId

store#

• store: KubeItemListStore<K>

Overrides#

Omit.store

subscribeStores#

• Optional subscribeStores: boolean

tableId#

• Optional tableId: string

Inherited from#

Omit.tableId

tableProps#

• Optional tableProps: Partial<TableProps<K>>

Inherited from#

Omit.tableProps

virtual#

• Optional virtual: boolean

Inherited from#

Omit.virtual