Skip to main content
Version: 2.0.0

Interface: EntitySidePanelProps<M>

Props used to open a side dialog

Type parameters

NameType
Mextends Record<string, any> = any

Properties

closeOnSave

Optional closeOnSave: boolean

Should this panel close when saving

Defined in

lib/src/types/side_entity_controller.tsx:66


collection

Optional collection: EntityCollection<M, string, User> | ResolvedEntityCollection<M>

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

Defined in

lib/src/types/side_entity_controller.tsx:42


copy

Optional copy: boolean

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

Defined in

lib/src/types/side_entity_controller.tsx:24


entityId

Optional entityId: string

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

Defined in

lib/src/types/side_entity_controller.tsx:19


onClose

Optional onClose: () => void

Type declaration

▸ (): void

Callback when the dialog is closed

Returns

void

Defined in

lib/src/types/side_entity_controller.tsx:61


onUpdate

Optional onUpdate: (params: { entity: Entity<any> }) => void

Type declaration

▸ (params): void

Callback when the entity is updated

Parameters
NameType
paramsObject
params.entityEntity<any>
Returns

void

Defined in

lib/src/types/side_entity_controller.tsx:56


path

path: string

Absolute path of the entity

Defined in

lib/src/types/side_entity_controller.tsx:14


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

lib/src/types/side_entity_controller.tsx:30


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

lib/src/types/side_entity_controller.tsx:50


width

Optional width: string | number

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

Defined in

lib/src/types/side_entity_controller.tsx:36

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!