EntityFormProps
@firecms/core / EntityFormProps
Type Alias: EntityFormProps<M>
Section titled “Type Alias: EntityFormProps<M>”EntityFormProps<
M> =object
Defined in: form/EntityForm.tsx:67
Type Parameters
Section titled “Type Parameters”M extends Record<string, any>
Properties
Section titled “Properties”Builder?
Section titled “Builder?”
optionalBuilder:React.ComponentType<EntityCustomViewParams<M>>
Defined in: form/EntityForm.tsx:102
children?
Section titled “children?”
optionalchildren:React.ReactNode
Defined in: form/EntityForm.tsx:104
className?
Section titled “className?”
optionalclassName:string
Defined in: form/EntityForm.tsx:80
collection
Section titled “collection”collection:
EntityCollection<M>
Defined in: form/EntityForm.tsx:70
databaseId?
Section titled “databaseId?”
optionaldatabaseId:string
Defined in: form/EntityForm.tsx:73
disabled?
Section titled “disabled?”
optionaldisabled:boolean
Defined in: form/EntityForm.tsx:89
If true, the form will be disabled and no actions will be available
entity?
Section titled “entity?”
optionalentity:Entity<M>
Defined in: form/EntityForm.tsx:72
EntityFormActionsComponent?
Section titled “EntityFormActionsComponent?”
optionalEntityFormActionsComponent:React.FC<EntityFormActionsProps>
Defined in: form/EntityForm.tsx:100
entityId?
Section titled “entityId?”
optionalentityId:string
Defined in: form/EntityForm.tsx:71
forceActionsAtTheBottom?
Section titled “forceActionsAtTheBottom?”
optionalforceActionsAtTheBottom:boolean
Defined in: form/EntityForm.tsx:79
formex?
Section titled “formex?”
optionalformex:FormexController<M>
Defined in: form/EntityForm.tsx:84
fullIdPath?
Section titled “fullIdPath?”
optionalfullIdPath:string
Defined in: form/EntityForm.tsx:69
initialDirtyValues?
Section titled “initialDirtyValues?”
optionalinitialDirtyValues:Partial<M>
Defined in: form/EntityForm.tsx:77
initialStatus
Section titled “initialStatus”initialStatus:
EntityStatus
Defined in: form/EntityForm.tsx:81
onEntityChange()?
Section titled “onEntityChange()?”
optionalonEntityChange: (entity) =>void
Defined in: form/EntityForm.tsx:83
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity<M>
Returns
Section titled “Returns”void
onFormContextReady()?
Section titled “onFormContextReady()?”
optionalonFormContextReady: (formContext) =>void
Defined in: form/EntityForm.tsx:78
Parameters
Section titled “Parameters”formContext
Section titled “formContext”Returns
Section titled “Returns”void
onIdChange()?
Section titled “onIdChange()?”
optionalonIdChange: (id) =>void
Defined in: form/EntityForm.tsx:74
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
onSaved()?
Section titled “onSaved()?”
optionalonSaved: (params) =>void
Defined in: form/EntityForm.tsx:76
Parameters
Section titled “Parameters”params
Section titled “params”OnUpdateParams
Returns
Section titled “Returns”void
onStatusChange()?
Section titled “onStatusChange()?”
optionalonStatusChange: (status) =>void
Defined in: form/EntityForm.tsx:82
Parameters
Section titled “Parameters”status
Section titled “status”Returns
Section titled “Returns”void
onValuesModified()?
Section titled “onValuesModified()?”
optionalonValuesModified: (modified,values) =>void
Defined in: form/EntityForm.tsx:75
Parameters
Section titled “Parameters”modified
Section titled “modified”boolean
values
Section titled “values”M
Returns
Section titled “Returns”void
openEntityMode?
Section titled “openEntityMode?”
optionalopenEntityMode:"side_panel"|"full_screen"
Defined in: form/EntityForm.tsx:85
path:
string
Defined in: form/EntityForm.tsx:68
showDefaultActions?
Section titled “showDefaultActions?”
optionalshowDefaultActions:boolean
Defined in: form/EntityForm.tsx:93
Include the copy and delete actions in the form
showEntityPath?
Section titled “showEntityPath?”
optionalshowEntityPath:boolean
Defined in: form/EntityForm.tsx:98
Display the entity path in the form
