Skip to main content
Version: 2.0.0

Interface: ReferenceDialogProps<M>

Type parameters

NameType
Mextends Record<string, any>

Properties

collection

Optional collection: EntityCollection<M, string, User>

Entity collection config

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:48


forceFilter

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

Allow selection of entities that pass the given filter only.

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:88


multiselect

Optional multiselect: boolean

Allow multiple selection of values

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:43


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

lib/src/core/components/ReferenceSelectionView.tsx:55


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

lib/src/core/components/ReferenceSelectionView.tsx:61

Methods

onClose

Optional onClose(): void

If the dialog currently open, close it

Returns

void

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:83


onMultipleEntitiesSelected

Optional onMultipleEntitiesSelected(entities): void

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

Parameters

NameType
entitiesEntity<any>[]

Returns

void

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:77


onSingleEntitySelected

Optional onSingleEntitySelected(entity): void

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

Parameters

NameType
entitynull | Entity<any>

Returns

void

Defined in

lib/src/core/components/ReferenceSelectionView.tsx:69

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!