Type Alias: EntityCollectionTableProps<M, UserType>

EntityCollectionTableProps<M, UserType>: object

Type Parameters

• M extends Record<string, any>

• UserType extends User = User

Type declaration

AddColumnComponent?

optional AddColumnComponent: React.ComponentType

AdditionalHeaderWidget?

optional AdditionalHeaderWidget: React.ComponentType<object>

Type declaration

onHover

onHover: boolean

property

property: ResolvedProperty

propertyKey

propertyKey: string

actions?

optional actions: React.ReactNode

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

actionsStart?

optional actionsStart: React.ReactNode

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

additionalFields?

optional additionalFields: AdditionalFieldDelegate<M, UserType>[]

additionalIDHeaderWidget?

optional additionalIDHeaderWidget: React.ReactNode

className?

optional className: string

defaultSize?

optional defaultSize: CollectionSize

displayedColumnIds?

optional displayedColumnIds: PropertyColumnConfig[]

emptyComponent?

optional emptyComponent: React.ReactNode

enablePopupIcon

enablePopupIcon: boolean

endAdornment?

optional endAdornment: React.ReactNode

filterable?

optional filterable: boolean

forceFilter?

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

getIdColumnWidth()?

optional getIdColumnWidth: () => number

Returns

number

getPropertyFor()?

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

Parameters

• props: GetPropertyForProps<M>

Returns

ResolvedProperties<M>[string]

highlightedEntities?

optional highlightedEntities: Entity<M>[]

List of entities that will be displayed as selected;

hoverRow?

optional hoverRow: boolean

Should apply a different style to a row when hovering

inlineEditing?

optional inlineEditing: boolean

onTextSearchClick()?

optional onTextSearchClick: () => void

Returns

void

onValueChange?

optional onValueChange: OnCellValueChange<any, M>

Callback when a cell value changes.

properties

properties: ResolvedProperties<M>

selectionController

selectionController: SelectionController<M>

Display these entities as selected

sortable?

optional sortable: boolean

style?

optional style: React.CSSProperties

tableController

tableController: EntityTableController<M>

Controller holding the logic for the table useDataSourceEntityCollectionTableController EntityTableController

tableRowActionsBuilder()?

optional tableRowActionsBuilder: (params) => React.ReactNode

Builder for creating the buttons in each row

Parameters

• params

• params.entity: Entity<M>

• params.frozen?: boolean

• params.size: CollectionSize

• params.width: number

Returns

React.ReactNode

textSearchEnabled?

optional textSearchEnabled: boolean

textSearchLoading?

optional textSearchLoading: boolean

title?

optional title: React.ReactNode

Override the title in the toolbar

uniqueFieldValidator?

optional uniqueFieldValidator: UniqueFieldValidator

onColumnResize()?

Callback when a column is resized

Parameters

• params: OnColumnResizeParams

Returns

void

onEntityClick()?

Callback when anywhere on the table is clicked

Parameters

• entity: Entity<M>

Returns

void

onSizeChanged()?

Callback when the selected size of the table is changed

Parameters

• size: CollectionSize

Returns

void

Defined in

packages/firecms_core/src/components/EntityCollectionTable/EntityCollectionTableProps.tsx:18