Skip to main content
Version: 3.0.0-beta

Function: useReferenceDialog()

useReferenceDialog<M>(referenceDialogProps): object

This hook is used to open a side dialog that allows the selection of entities under a given path. You can use it in custom views for selecting entities. You need to specify the path of the target collection at least. If your collection is not defined in your top collection configuration (in your FireCMS component), you need to specify explicitly. This is the same hook used internally when a reference property is defined.

Type Parameters​

• M extends Record<string, any>

Parameters​

• referenceDialogProps: Omit<ReferenceSelectionInnerProps<M>, "path"> & object

Returns​

object

close()​

close: () => void

Returns​

void

open()​

open: () => void

Returns​

void

Defined in​

packages/firecms_core/src/hooks/useReferenceDialog.tsx:16

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