Interface: EntitySidePanelProps<M>

Props used to open a side dialog

Type Parameters

• M extends Record<string, any> = any

Properties

closeOnSave?

optional closeOnSave: boolean

Should this panel close when saving

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:67

---

collection?

optional collection: EntityCollection<M, any> | ResolvedEntityCollection<M>

Collection representing the entities of this view. If you leave it blank it will be induced by your navigation

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:43

---

copy?

optional copy: boolean

Set this flag to true if you want to make a copy of an existing entity

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:25

---

entityId?

optional entityId: string

ID of the entity, if not set, it means we are creating a new entity

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:20

---

onClose()?

optional onClose: () => void

Callback when the dialog is closed

Returns

void

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:62

---

onUpdate()?

optional onUpdate: (params) => void

Callback when the entity is updated

Parameters

• params

• params.entity: Entity<any>

Returns

void

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:57

---

path

path: string

Absolute path of the entity

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:15

---

selectedSubPath?

optional selectedSubPath: string

Open the entity with a selected sub-collection view. If the panel for this entity was already open, it is replaced.

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:31

---

updateUrl?

optional updateUrl: boolean

Should update the URL when opening the dialog. Consider that if the collection that you provide is not defined in the base config of your FireCMS component, you will not be able to recreate the state if copying the URL to a different window.

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:51

---

width?

optional width: string | number

Use this prop to override the width of the form view. e.g. "600px"

Defined in

packages/firecms_core/src/types/side_entity_controller.tsx:37