Skip to main content

Interface: CollectionTableProps<M, AdditionalKey>

Type parameters

NameType
Mextends Object
AdditionalKeyextends string = string

Properties

collection

โ€ข collection: EntityCollection<M, string, any> | EntityCollectionResolver<M>

Collection

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:29


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

core/components/CollectionTable/CollectionTableProps.tsx:50


hoverRow

โ€ข Optional hoverRow: boolean

Should apply a different style to a row when hovering

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:86


inlineEditing

โ€ข inlineEditing: boolean | (entity: Entity<any>) => boolean

Can the table be edited inline

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:44


path

โ€ข path: string

Absolute collection path

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:24


schemaResolver

โ€ข schemaResolver: EntitySchemaResolver<M>

Use to resolve the schema properties for specific path, entity id or values

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:34


title

โ€ข Optional title: ReactNode

Override the title in the toolbar

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:39

Methods

onColumnResize

โ–ธ Optional onColumnResize(params): void

Callback when a column is resized

Parameters

NameType
paramsOnColumnResizeParams

Returns

void

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:76


onEntityClick

โ–ธ Optional onEntityClick(entity): void

Callback when anywhere on the table is clicked

Parameters

NameType
entityEntity<M>

Returns

void

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:71


onSizeChanged

โ–ธ Optional onSizeChanged(size): void

Callback when the selected size of the table is changed

Parameters

NameType
sizeCollectionSize

Returns

void

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:81


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

core/components/CollectionTable/CollectionTableProps.tsx:63


toolbarActionsBuilder

โ–ธ Optional toolbarActionsBuilder(props): ReactNode

Additional components builder such as buttons in the collection toolbar

Parameters

NameType
propsObject
props.dataEntity<any>[]
props.sizeCollectionSize

Returns

ReactNode

Defined in

core/components/CollectionTable/CollectionTableProps.tsx:56