Skip to main content
Version: 3.0.0-beta

Interface: ReferenceSelectionInnerProps<M>

Type Parameters​

• M extends Record<string, any>

Properties​

collection?​

optional collection: EntityCollection<M, any>

Entity collection config

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:38


description?​

optional description: ReactNode

Use this description to indicate the user what to do in this dialog.

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:77


forceFilter?​

optional forceFilter: Partial<Record<string, [WhereFilterOp, any]>>

Allow selection of entities that pass the given filter only.

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:72


maxSelection?​

optional maxSelection: number

Maximum number of entities that can be selected.

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:82


multiselect?​

optional multiselect: boolean

Allow multiple selection of values

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:33


path​

path: string

Absolute path of the collection. May be not set if this hook is being used in a component and the path is dynamic. If not set, the dialog won't open.

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:45


selectedEntityIds?​

optional selectedEntityIds: string[]

If you are opening the dialog for the first time, you can select some entity ids to be displayed first.

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:51

Methods​

onMultipleEntitiesSelected()?​

optional onMultipleEntitiesSelected(entities): void

If multiselect is set to true, you will get the selected entities in this callback.

Parameters​

• entities: Entity<any>[]

Returns​

void

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:67


onSingleEntitySelected()?​

optional onSingleEntitySelected(entity): void

If multiselect is set to false, you will get the selected entity in this callback.

Parameters​

• entity: Entity<any>

Returns​

void

Defined in​

packages/firecms_core/src/components/ReferenceTable/ReferenceSelectionTable.tsx:59

Sign up to our newsletter to get the latest news and updates. No spam!