Skip to main content
Version: 2.0.0-alpha

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

NameType
Mextends Record<string, any>

Parameters

NameType
referenceDialogPropsOmit<ReferenceDialogProps<M>, "path"> & { path?: string | false }

Returns

Object

NameType
close() => void
open() => void

Defined in

lib/src/hooks/useReferenceDialog.tsx:16