ReferenceWidgetProps

@firecms/core

---

@firecms/core / ReferenceWidgetProps

Type Alias: ReferenceWidgetProps<M>

ReferenceWidgetProps<M> = object

Defined in: components/ReferenceWidget.tsx:9

Type Parameters

M

M extends Record<string, any>

Properties

className?

optional className: string

Defined in: components/ReferenceWidget.tsx:29

---

disabled?

optional disabled: boolean

Defined in: components/ReferenceWidget.tsx:22

---

forceFilter?

optional forceFilter: FilterValues<string>

Defined in: components/ReferenceWidget.tsx:27

Allow selection of entities that pass the given filter only.

---

includeEntityLink?

optional includeEntityLink: boolean

Defined in: components/ReferenceWidget.tsx:31

---

includeId?

optional includeId: boolean

Defined in: components/ReferenceWidget.tsx:30

---

multiselect?

optional multiselect: boolean

Defined in: components/ReferenceWidget.tsx:11

---

name?

optional name: string

Defined in: components/ReferenceWidget.tsx:10

---

onMultipleReferenceSelected()?

optional onMultipleReferenceSelected: (params) => void

Defined in: components/ReferenceWidget.tsx:17

Parameters

params

entities

Entity<M>[] | null

references

EntityReference[] | null

Returns

void

---

onReferenceSelected()?

optional onReferenceSelected: (params) => void

Defined in: components/ReferenceWidget.tsx:13

Parameters

params

entity

Entity<M> | null

reference

EntityReference | null

Returns

void

---

path

path: string

Defined in: components/ReferenceWidget.tsx:21

---

previewProperties?

optional previewProperties: string[]

Defined in: components/ReferenceWidget.tsx:23

---

size

size: PreviewSize

Defined in: components/ReferenceWidget.tsx:28

---

value

value: EntityReference | EntityReference[] | null

Defined in: components/ReferenceWidget.tsx:12