Interface: ReferenceDialogProps
Properties​
collection​
• collection: EntityCollection<any, string, User>
Entity collection config
Defined in​
lib/src/core/components/ReferenceDialog.tsx:28
multiselect​
• multiselect: boolean
Allow multiple selection of values
Defined in​
lib/src/core/components/ReferenceDialog.tsx:23
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/ReferenceDialog.tsx:35
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/ReferenceDialog.tsx:41
Methods​
onClose​
â–¸ Optional onClose(): void
Is the dialog currently open
Returns​
void
Defined in​
lib/src/core/components/ReferenceDialog.tsx:63
onMultipleEntitiesSelected​
â–¸ Optional onMultipleEntitiesSelected(entities): void
If multiselect is set to true, you will get the selected entities
in this callback.
Parameters​
| Name | Type |
|---|---|
entities | Entity<any>[] |
Returns​
void
Defined in​
lib/src/core/components/ReferenceDialog.tsx:57
onSingleEntitySelected​
â–¸ Optional onSingleEntitySelected(entity): void
If multiselect is set to false, you will get the select entity
in this callback.
Parameters​
| Name | Type |
|---|---|
entity | null | Entity<any> |
Returns​
void