Skip to main content

Interface: SideEntityPanelProps<M, UserType>

Props used to open a side dialog

Type parameters

NameType
Many
UserTypeUser

Properties

callbacks

โ€ข Optional callbacks: EntityCallbacks<M>

This interface defines all the callbacks that can be used when an entity is being created, updated or deleted. Useful for adding your own logic or blocking the execution of the operation

Defined in

models/side_entity_controller.tsx:61


copy

โ€ข Optional copy: boolean

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

Defined in

models/side_entity_controller.tsx:26


entityId

โ€ข Optional entityId: string

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

Defined in

models/side_entity_controller.tsx:21


overrideSchemaRegistry

โ€ข Optional overrideSchemaRegistry: boolean

Defined in

models/side_entity_controller.tsx:64


path

โ€ข path: string

Absolute path of the entity

Defined in

models/side_entity_controller.tsx:16


permissions

โ€ข Optional permissions: PermissionsBuilder<M, UserType>

Can the elements in this collection be added and edited.

Defined in

models/side_entity_controller.tsx:43


schema

โ€ข Optional schema: EntitySchema<M> | EntitySchemaResolver<M>

Schema representing the entities of this view

Defined in

models/side_entity_controller.tsx:48


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

models/side_entity_controller.tsx:32


subcollections

โ€ข Optional subcollections: EntityCollection<any, string, any>[]

You can add subcollections to your entity in the same way you define the root collections.

Defined in

models/side_entity_controller.tsx:54


width

โ€ข Optional width: string | number

Use this prop to override the width of the side dialog. e.g. "600px"

Defined in

models/side_entity_controller.tsx:38