EntityCustomView
@firecms/core / EntityCustomView
Type Alias: EntityCustomView<M>
Section titled “Type Alias: EntityCustomView<M>”EntityCustomView<
M> =object
Defined in: types/collections.ts:537
You can use this builder to render a custom panel in the entity detail view. It gets rendered as a tab.
Type Parameters
Section titled “Type Parameters”M extends Record<string, any> = any
Properties
Section titled “Properties”Builder?
Section titled “Builder?”
optionalBuilder:React.ComponentType<EntityCustomViewParams<M>>
Defined in: types/collections.ts:565
Builder for rendering the custom view
includeActions?
Section titled “includeActions?”
optionalincludeActions:boolean|"bottom"
Defined in: types/collections.ts:560
If set to true, the actions of the entity (save, discard,delete) will be included in the view. By default the actions are located in the right or bottom, based on the screen size. You can force the actions to be located at the bottom by setting this prop to “bottom”.
key:
string
Defined in: types/collections.ts:542
Key of this custom view.
name:
string
Defined in: types/collections.ts:547
Name of this custom view.
position?
Section titled “position?”
optionalposition:"start"|"end"
Defined in: types/collections.ts:570
Position of this tab in the entity view. Defaults to end.
tabComponent?
Section titled “tabComponent?”
optionaltabComponent:React.ReactNode
Defined in: types/collections.ts:552
Render this custom view in the tab of the entity view, instead of the name
