Interface: KubeObjectListLayoutProps<K>#
Renderer.Component.KubeObjectListLayoutProps
Type parameters#
Name | Type |
---|---|
K |
extends KubeObject |
Hierarchy#
ItemListLayoutPropsWithoutGetItems
<K
>
↳ KubeObjectListLayoutProps
Table of contents#
Properties#
- addRemoveButtons
- className
- copyClassNameFromHeadCells
- customizeHeader
- dependentStores
- detailsItem
- failedToLoadMessage
- filterCallbacks
- filterItems
- hasDetailsView
- headerClassName
- hideFilters
- isConfigurable
- isReady
- isSelectable
- items
- preloadStores
- renderHeaderTitle
- renderTableHeader
- searchFilters
- showHeader
- sortingCallbacks
- store
- subscribeStores
- tableId
- tableProps
- virtual
Methods#
- customizeRemoveDialog
- customizeTableRowProps
- getItems
- onDetails
- renderFooter
- renderItemMenu
- renderTableContents
Properties#
addRemoveButtons#
• Optional
addRemoveButtons: Partial
<AddRemoveButtonsProps
>
Inherited from#
ItemListLayoutPropsWithoutGetItems.addRemoveButtons
className#
• className: IClassName
Inherited from#
ItemListLayoutPropsWithoutGetItems.className
copyClassNameFromHeadCells#
• Optional
copyClassNameFromHeadCells: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.copyClassNameFromHeadCells
customizeHeader#
• Optional
customizeHeader: HeaderCustomizer
| HeaderCustomizer
[]
Inherited from#
ItemListLayoutPropsWithoutGetItems.customizeHeader
dependentStores#
• Optional
dependentStores: KubeObjectStore
<KubeObject
<KubeObjectMetadata
, any
, any
>>[]
Overrides#
ItemListLayoutPropsWithoutGetItems.dependentStores
detailsItem#
• Optional
detailsItem: K
Inherited from#
ItemListLayoutPropsWithoutGetItems.detailsItem
failedToLoadMessage#
• Optional
failedToLoadMessage: ReactNode
Message to display when a store failed to load
default
"Failed to load items"
Inherited from#
ItemListLayoutPropsWithoutGetItems.failedToLoadMessage
filterCallbacks#
• Optional
filterCallbacks: ItemsFilters
<K
>
Inherited from#
ItemListLayoutPropsWithoutGetItems.filterCallbacks
filterItems#
• Optional
filterItems: ItemsFilter
<K
>[]
deprecated
Inherited from#
ItemListLayoutPropsWithoutGetItems.filterItems
hasDetailsView#
• Optional
hasDetailsView: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.hasDetailsView
headerClassName#
• Optional
headerClassName: IClassName
Inherited from#
ItemListLayoutPropsWithoutGetItems.headerClassName
hideFilters#
• Optional
hideFilters: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.hideFilters
isConfigurable#
• Optional
isConfigurable: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.isConfigurable
isReady#
• Optional
isReady: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.isReady
isSelectable#
• Optional
isSelectable: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.isSelectable
items#
• Optional
items: K
[]
preloadStores#
• Optional
preloadStores: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.preloadStores
renderHeaderTitle#
• Optional
renderHeaderTitle: ReactNode
| (parent
: NonInjectedItemListLayout
<K
>) => ReactNode
Inherited from#
ItemListLayoutPropsWithoutGetItems.renderHeaderTitle
renderTableHeader#
• renderTableHeader: TableCellProps
[]
Inherited from#
ItemListLayoutPropsWithoutGetItems.renderTableHeader
searchFilters#
• Optional
searchFilters: SearchFilter
<K
>[]
Inherited from#
ItemListLayoutPropsWithoutGetItems.searchFilters
showHeader#
• Optional
showHeader: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.showHeader
sortingCallbacks#
• Optional
sortingCallbacks: TableSortCallbacks
<K
>
Inherited from#
ItemListLayoutPropsWithoutGetItems.sortingCallbacks
store#
• store: KubeObjectStore
<K
>
Overrides#
ItemListLayoutPropsWithoutGetItems.store
subscribeStores#
• Optional
subscribeStores: boolean
tableId#
• Optional
tableId: string
Inherited from#
ItemListLayoutPropsWithoutGetItems.tableId
tableProps#
• Optional
tableProps: Partial
<TableProps
<K
>>
Inherited from#
ItemListLayoutPropsWithoutGetItems.tableProps
virtual#
• Optional
virtual: boolean
Inherited from#
ItemListLayoutPropsWithoutGetItems.virtual
Methods#
customizeRemoveDialog#
▸ Optional
customizeRemoveDialog(selectedItems
): Partial
<ConfirmDialogParams
>
Parameters#
Name | Type |
---|---|
selectedItems |
I [] |
Returns#
Partial
<ConfirmDialogParams
>
Inherited from#
ItemListLayoutPropsWithoutGetItems.customizeRemoveDialog
customizeTableRowProps#
▸ Optional
customizeTableRowProps(item
): Partial
<TableRowProps
>
Parameters#
Name | Type |
---|---|
item |
I |
Returns#
Partial
<TableRowProps
>
Inherited from#
ItemListLayoutPropsWithoutGetItems.customizeTableRowProps
getItems#
▸ Optional
getItems(): K
[]
Returns#
K
[]
onDetails#
▸ Optional
onDetails(item
): void
Parameters#
Name | Type |
---|---|
item |
I |
Returns#
void
Inherited from#
ItemListLayoutPropsWithoutGetItems.onDetails
renderFooter#
▸ Optional
renderFooter(parent
): ReactNode
Parameters#
Name | Type |
---|---|
parent |
NonInjectedItemListLayout <I > |
Returns#
ReactNode
Inherited from#
ItemListLayoutPropsWithoutGetItems.renderFooter
renderItemMenu#
▸ Optional
renderItemMenu(item
, store
): ReactNode
Parameters#
Name | Type |
---|---|
item |
I |
store |
ItemStore <I > |
Returns#
ReactNode
Inherited from#
ItemListLayoutPropsWithoutGetItems.renderItemMenu
renderTableContents#
▸ renderTableContents(item
): (ReactNode
| TableCellProps
)[]
Parameters#
Name | Type |
---|---|
item |
I |
Returns#
(ReactNode
| TableCellProps
)[]
Inherited from#
ItemListLayoutPropsWithoutGetItems.renderTableContents