Skip to main content

EntitySidePanelProps <M>

Props used to open a side dialog

Index

Properties

optionalcloseOnSave

closeOnSave?: boolean

Should this panel close when saving

optionalcollection

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

optionalcopy

copy?: boolean

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

optionalentityId

entityId?: string

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

optionalonClose

onClose?: () => void

Callback when the dialog is closed


Type declaration

    • (): void
    • Returns void

optionalonUpdate

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

Callback when the entity is updated


Type declaration

    • (params: { entity: Entity<any> }): void
    • Parameters

      • params: { entity: Entity<any> }

      Returns void

path

path: string

Absolute path of the entity

optionalselectedSubPath

selectedSubPath?: string

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

optionalupdateUrl

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.

optionalwidth

width?: string | number

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

Sign up to our newsletter to get the latest news and updates. No spam!