Skip to main content
Version: 2.0.0-alpha

Interface: EntityCollectionTableProps<M>

Type parameters

NameType
Mextends Object

Properties

Actions

Optional Actions: ReactNode

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

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:44


ActionsStart

Optional ActionsStart: ReactNode

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

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:50


Title

Optional Title: ReactNode

Override the title in the toolbar

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:38


collection

collection: EntityCollection<M, string, User>

Collection

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:22


entitiesDisplayedFirst

Optional entitiesDisplayedFirst: Entity<M>[]

List of entities that will be displayed on top, no matter the ordering. This is used for reference fields selection

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:33


hoverRow

Optional hoverRow: boolean

Should apply a different style to a row when hovering

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:80


inlineEditing

inlineEditing: boolean | (entity: Entity<M>) => boolean

Can the table be edited inline

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:27


path

path: string

Absolute collection path

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:17

Methods

onColumnResize

Optional onColumnResize(params): void

Callback when a column is resized

Parameters

NameType
paramsOnColumnResizeParams

Returns

void

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:70


onEntityClick

Optional onEntityClick(entity): void

Callback when anywhere on the table is clicked

Parameters

NameType
entityEntity<M>

Returns

void

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:65


onSizeChanged

Optional onSizeChanged(size): void

Callback when the selected size of the table is changed

Parameters

NameType
sizeCollectionSize

Returns

void

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:75


tableRowActionsBuilder

Optional tableRowActionsBuilder(__namedParameters): ReactNode

Builder for creating the buttons in each row

Parameters

NameType
__namedParametersObject
__namedParameters.entityEntity<M>
__namedParameters.sizeCollectionSize

Returns

ReactNode

Defined in

lib/src/core/components/CollectionTable/EntityCollectionTableProps.tsx:57