Skip to content
FireCMS Logo FireCMS

SelectableTableProps

@firecms/core

@firecms/core / SelectableTableProps

Type Alias: SelectableTableProps<M>

Section titled “Type Alias: SelectableTableProps<M>”

SelectableTableProps<M> = object

Defined in: components/SelectableTable/SelectableTable.tsx:22

Type Parameters

Section titled “Type Parameters”

M

Section titled “M”

M extends Record<string, any>

Properties

Section titled “Properties”

AddColumnComponent?

Section titled “AddColumnComponent?”

optional AddColumnComponent: React.ComponentType

Defined in: components/SelectableTable/SelectableTable.tsx:95

cellRenderer

Section titled “cellRenderer”

cellRenderer: React.ComponentType<CellRendererParams<Entity<M>>>

Defined in: components/SelectableTable/SelectableTable.tsx:31

columns

Section titled “columns”

columns: VirtualTableColumn[]

Defined in: components/SelectableTable/SelectableTable.tsx:29

emptyComponent?

Section titled “emptyComponent?”

optional emptyComponent: React.ReactNode

Defined in: components/SelectableTable/SelectableTable.tsx:91

endAdornment?

Section titled “endAdornment?”

optional endAdornment: React.ReactNode

Defined in: components/SelectableTable/SelectableTable.tsx:93

filterable?

Section titled “filterable?”

optional filterable: boolean

Defined in: components/SelectableTable/SelectableTable.tsx:67

forceFilter?

Section titled “forceFilter?”

optional forceFilter: FilterValues<keyof M extends string ? keyof M : never>

Defined in: components/SelectableTable/SelectableTable.tsx:73

highlightedRow()?

Section titled “highlightedRow()?”

optional highlightedRow: (data) => boolean

Defined in: components/SelectableTable/SelectableTable.tsx:75

Parameters

Section titled “Parameters”
data
Section titled “data”

Entity<M>

Returns

Section titled “Returns”

boolean

hoverRow?

Section titled “hoverRow?”

optional hoverRow: boolean

Defined in: components/SelectableTable/SelectableTable.tsx:58

Should apply a different style to a row when hovering

initialScroll?

Section titled “initialScroll?”

optional initialScroll: number

Defined in: components/SelectableTable/SelectableTable.tsx:79

inlineEditing?

Section titled “inlineEditing?”

optional inlineEditing: boolean

Defined in: components/SelectableTable/SelectableTable.tsx:71

onScroll()?

Section titled “onScroll()?”

optional onScroll: (props) => void

Defined in: components/SelectableTable/SelectableTable.tsx:85

Callback when the table is scrolled

Parameters

Section titled “Parameters”
props
Section titled “props”
scrollDirection
Section titled “scrollDirection”

"forward" | "backward"

scrollOffset
Section titled “scrollOffset”

number

scrollUpdateWasRequested
Section titled “scrollUpdateWasRequested”

boolean

Returns

Section titled “Returns”

void

onValueChange?

Section titled “onValueChange?”

optional onValueChange: OnCellValueChange<any, M>

Defined in: components/SelectableTable/SelectableTable.tsx:27

Callback when a cell value changes.

size?

Section titled “size?”

optional size: CollectionSize

Defined in: components/SelectableTable/SelectableTable.tsx:77

sortable?

Section titled “sortable?”

optional sortable: boolean

Defined in: components/SelectableTable/SelectableTable.tsx:69

tableController

Section titled “tableController”

tableController: EntityTableController<M>

Defined in: components/SelectableTable/SelectableTable.tsx:65

Controller holding the logic for the table useDataSourceTableController EntityTableController

tableRowActionsBuilder()?

Section titled “tableRowActionsBuilder()?”

optional tableRowActionsBuilder: (params) => React.ReactNode

Defined in: components/SelectableTable/SelectableTable.tsx:38

Builder for creating the buttons in each row

Parameters

Section titled “Parameters”
params
Section titled “params”
entity
Section titled “entity”

Entity<M>

frozen?
Section titled “frozen?”

boolean

size
Section titled “size”

CollectionSize

width
Section titled “width”

number

Returns

Section titled “Returns”

React.ReactNode

Methods

Section titled “Methods”

onColumnResize()?

Section titled “onColumnResize()?”

optional onColumnResize(params): void

Defined in: components/SelectableTable/SelectableTable.tsx:53

Callback when a column is resized

Parameters

Section titled “Parameters”
params
Section titled “params”

OnColumnResizeParams

Returns

Section titled “Returns”

void

onEntityClick()?

Section titled “onEntityClick()?”

optional onEntityClick(entity): void

Defined in: components/SelectableTable/SelectableTable.tsx:48

Callback when anywhere on the table is clicked

Parameters

Section titled “Parameters”
entity
Section titled “entity”

Entity<M>

Returns

Section titled “Returns”

void