interface

FieldReferenceBrowserProps

Props for the framework-owned reference picker.

Properties

Property	Type	Description
`open`	`boolean`	The open value.
`field`	`SchemaField`	The field value.
`collection`	`SchemaCollection`	The collection value.
`collections`	`readonly SchemaCollection[]`	Optional collection choices. Only readable collections are offered; switching clears the current list query and uncommitted selection.
`hasMany`	`boolean`	The hasMany value.
`selectedIDs`	`readonly string[]`	The selectedIDs value.
`readOnly`	`boolean`	The readOnly value.
`initialDocument`	`FieldDocument`	The initialDocument value.
`initialDocumentID`	`string`	The initialDocumentID value.
`initialCreate`	`boolean`	Open a new document form immediately when creation is permitted.
`initialFile`	`File`	File dropped into an upload field; opens a new metadata form before any upload is saved.
`optionFilter`	`FieldReferenceFilter \| readonly FieldReferenceFilter[] \| ((collection: SchemaCollection) => FieldReferenceFilter \| readonly FieldReferenceFilter[] \| undefined)`	The optionFilter value.
`defaultValues`	`Readonly<Record<string, unknown>>`	The defaultValues value.
`allowCreate`	`boolean`	The allowCreate value.
`locale`	`string`	The locale value.
`onCommit`	`(ids: string[], collectionSlug: string) => void \| boolean \| Promise<void \| boolean>`	The onCommit value.
`onClose`	`() => void`	The onClose value.

Full signature

interface FieldReferenceBrowserProps { ... }

Source packages/plugin/src/lib/index.ts:10

Methods

FieldReferenceBrowserProps.onClose()
Public method FieldReferenceBrowserProps.onClose from @riducms/plugin.
FieldReferenceBrowserProps.onCommit()
Public method FieldReferenceBrowserProps.onCommit from @riducms/plugin.