EntityCustomViewParams
@firecms/core / EntityCustomViewParams
Interface: EntityCustomViewParams<M>
Section titled “Interface: EntityCustomViewParams<M>”Defined in: types/collections.ts:578
Parameters passed to the builder in charge of rendering a custom panel for an entity view.
Type Parameters
Section titled “Type Parameters”M extends Record<string, any> = any
Properties
Section titled “Properties”collection
Section titled “collection”collection:
EntityCollection<M>
Defined in: types/collections.ts:583
collection used by this entity
entity?
Section titled “entity?”
optionalentity:Entity<M>
Defined in: types/collections.ts:588
Entity that this view refers to. It can be undefined if the entity is new
formContext
Section titled “formContext”formContext:
FormContext
Defined in: types/collections.ts:600
Use the form context to access the form state and methods
modifiedValues?
Section titled “modifiedValues?”
optionalmodifiedValues:M
Defined in: types/collections.ts:595
Modified values in the form that have not been saved yet.
If the entity is not new and the values are not modified, these values
are the same as in entity
parentCollectionIds?
Section titled “parentCollectionIds?”
optionalparentCollectionIds:string[]
Defined in: types/collections.ts:605
If this is a subcollection, this is the path of the parent collections