Skip to content
FireCMS Logo FireCMS

EntityCollectionTableProps

@firecms/core

@firecms/core / EntityCollectionTableProps

Type Alias: EntityCollectionTableProps<M, USER>

Section titled “Type Alias: EntityCollectionTableProps<M, USER>”

EntityCollectionTableProps<M, USER> = object

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:18

Type Parameters

Section titled “Type Parameters”

M

Section titled “M”

M extends Record<string, any>

USER

Section titled “USER”

USER extends User = User

Properties

Section titled “Properties”

actions?

Section titled “actions?”

optional actions: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:104

Additional component that renders actions such as buttons in the collection toolbar, displayed on the right side

actionsStart?

Section titled “actionsStart?”

optional actionsStart: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:44

Additional component that renders actions such as buttons in the collection toolbar, displayed on the left side

AddColumnComponent?

Section titled “AddColumnComponent?”

optional AddColumnComponent: React.ComponentType

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:141

additionalFields?

Section titled “additionalFields?”

optional additionalFields: AdditionalFieldDelegate<M, USER>[]

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:121

AdditionalHeaderWidget?

Section titled “AdditionalHeaderWidget?”

optional AdditionalHeaderWidget: React.ComponentType<{ onHover: boolean; property: ResolvedProperty; propertyKey: string; }>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:135

additionalIDHeaderWidget?

Section titled “additionalIDHeaderWidget?”

optional additionalIDHeaderWidget: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:143

className?

Section titled “className?”

optional className: string

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:21

defaultSize?

Section titled “defaultSize?”

optional defaultSize: CollectionSize

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:123

displayedColumnIds?

Section titled “displayedColumnIds?”

optional displayedColumnIds: PropertyColumnConfig[]

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:113

emptyComponent?

Section titled “emptyComponent?”

optional emptyComponent: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:145

enablePopupIcon

Section titled “enablePopupIcon”

enablePopupIcon: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:153

endAdornment?

Section titled “endAdornment?”

optional endAdornment: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:133

filterable?

Section titled “filterable?”

optional filterable: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:129

forceFilter?

Section titled “forceFilter?”

optional forceFilter: FilterValues<Extract<keyof M, string>>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:115

getIdColumnWidth()?

Section titled “getIdColumnWidth()?”

optional getIdColumnWidth: () => number

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:147

Returns

Section titled “Returns”

number

getPropertyFor()?

Section titled “getPropertyFor()?”

optional getPropertyFor: (props) => ResolvedProperties<M>[string]

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:127

Parameters

Section titled “Parameters”
props
Section titled “props”

GetPropertyForProps<M>

Returns

Section titled “Returns”

ResolvedProperties<M>[string]

highlightedEntities?

Section titled “highlightedEntities?”

optional highlightedEntities: Entity<M>[]

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:33

List of entities that will be displayed as selected;

hoverRow?

Section titled “hoverRow?”

optional hoverRow: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:98

Should apply a different style to a row when hovering

initialScroll?

Section titled “initialScroll?”

optional initialScroll: number

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:78

Initial scroll position

inlineEditing?

Section titled “inlineEditing?”

optional inlineEditing: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:119

onScroll()?

Section titled “onScroll()?”

optional onScroll: (props) => void

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:84

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

onTextSearchClick()?

Section titled “onTextSearchClick()?”

optional onTextSearchClick: () => void

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:149

Returns

Section titled “Returns”

void

onValueChange?

Section titled “onValueChange?”

optional onValueChange: OnCellValueChange<any, M>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:49

Callback when a cell value changes.

openEntityMode?

Section titled “openEntityMode?”

optional openEntityMode: "side_panel" | "full_screen"

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:155

properties

Section titled “properties”

properties: ResolvedProperties<M>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:125

selectionController

Section titled “selectionController”

selectionController: SelectionController<M>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:28

Display these entities as selected

sortable?

Section titled “sortable?”

optional sortable: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:131

style?

Section titled “style?”

optional style: React.CSSProperties

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:23

tableController

Section titled “tableController”

tableController: EntityTableController<M>

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:111

Controller holding the logic for the table useDataSourceTableController EntityTableController

tableRowActionsBuilder()?

Section titled “tableRowActionsBuilder()?”

optional tableRowActionsBuilder: (params) => React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:58

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

textSearchEnabled?

Section titled “textSearchEnabled?”

optional textSearchEnabled: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:117

textSearchLoading?

Section titled “textSearchLoading?”

optional textSearchLoading: boolean

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:151

title?

Section titled “title?”

optional title: React.ReactNode

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:38

Override the title in the toolbar

uniqueFieldValidator?

Section titled “uniqueFieldValidator?”

optional uniqueFieldValidator: UniqueFieldValidator

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:51

Methods

Section titled “Methods”

onColumnResize()?

Section titled “onColumnResize()?”

optional onColumnResize(params): void

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:73

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/EntityCollectionTable/EntityCollectionTableProps.tsx:68

Callback when anywhere on the table is clicked

Parameters

Section titled “Parameters”
entity
Section titled “entity”

Entity<M>

Returns

Section titled “Returns”

void

onSizeChanged()?

Section titled “onSizeChanged()?”

optional onSizeChanged(size): void

Defined in: components/EntityCollectionTable/EntityCollectionTableProps.tsx:93

Callback when the selected size of the table is changed

Parameters

Section titled “Parameters”
size
Section titled “size”

CollectionSize

Returns

Section titled “Returns”

void