Skip to main content

ReferenceSelectionInnerProps <M>

Index

Properties

optionalcollection

collection?: EntityCollection<M, any>

Entity collection config

optionaldescription

description?: ReactNode

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

optionalforceFilter

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

Allow selection of entities that pass the given filter only.

optionalmaxSelection

maxSelection?: number

Maximum number of entities that can be selected.

optionalmultiselect

multiselect?: boolean

Allow multiple selection of values

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.

optionalselectedEntityIds

selectedEntityIds?: string[]

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

Methods

optionalonMultipleEntitiesSelected

  • onMultipleEntitiesSelected(entities: Entity<any>[]): void
  • If multiselect is set to true, you will get the selected entities in this callback.


    Parameters

    Returns void

optionalonSingleEntitySelected

  • onSingleEntitySelected(entity: null | Entity<any>): void
  • If multiselect is set to false, you will get the selected entity in this callback.


    Parameters

    Returns void

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