Skip to content
FireCMS Logo FireCMS

FireCMSPlugin

@firecms/core

@firecms/core / FireCMSPlugin

Type Alias: FireCMSPlugin<PROPS, FORM_PROPS, EC, COL_ACTIONS_PROPS, COL_ACTIONS_START__PROPS>

Section titled “Type Alias: FireCMSPlugin<PROPS, FORM_PROPS, EC, COL_ACTIONS_PROPS, COL_ACTIONS_START__PROPS>”

FireCMSPlugin<PROPS, FORM_PROPS, EC, COL_ACTIONS_PROPS, COL_ACTIONS_START__PROPS> = object

Defined in: types/plugins.tsx:18

Interface used to define plugins for FireCMS. NOTE: This is a work in progress and the API is not stable yet.

Type Parameters

Section titled “Type Parameters”

PROPS

Section titled “PROPS”

PROPS = any

FORM_PROPS

Section titled “FORM_PROPS”

FORM_PROPS = any

EC

Section titled “EC”

EC extends EntityCollection = EntityCollection

COL_ACTIONS_PROPS

Section titled “COL_ACTIONS_PROPS”

COL_ACTIONS_PROPS = any

COL_ACTIONS_START__PROPS

Section titled “COL_ACTIONS_START__PROPS”

COL_ACTIONS_START__PROPS = any

Properties

Section titled “Properties”

collection?

Section titled “collection?”

optional collection: object

Defined in: types/plugins.tsx:187

injectCollections()?

Section titled “injectCollections()?”

optional injectCollections: (collections) => EntityCollection[]

Use this method to modify, add or remove collections.

Parameters
Section titled “Parameters”
collections
Section titled “collections”

EntityCollection[]

Returns
Section titled “Returns”

EntityCollection[]

modifyCollection()?

Section titled “modifyCollection()?”

optional modifyCollection: (collection) => EntityCollection

Use this method to modify a single collection before it is rendered.

Parameters
Section titled “Parameters”
collection
Section titled “collection”

EntityCollection

Returns
Section titled “Returns”

EntityCollection

collectionView?

Section titled “collectionView?”

optional collectionView: object

Defined in: types/plugins.tsx:107

AddColumnComponent?

Section titled “AddColumnComponent?”

optional AddColumnComponent: React.ComponentType<{ collection: EC; fullPath: string; parentCollectionIds: string[]; tableController: EntityTableController; }>

If you add this callback to your plugin, an add button will be added to the collection table. TODO: Only the first plugin that defines this callback will be used, at the moment.

blockSearch()?

Section titled “blockSearch()?”

optional blockSearch: (props) => boolean

Parameters
Section titled “Parameters”
props
Section titled “props”
collection
Section titled “collection”

EC

context
Section titled “context”

FireCMSContext

parentCollectionIds?
Section titled “parentCollectionIds?”

string[]

path
Section titled “path”

string

Returns
Section titled “Returns”

boolean

CollectionActions?

Section titled “CollectionActions?”

optional CollectionActions: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS>[]

Use this component to add custom actions to the entity collections toolbar.

collectionActionsProps?

Section titled “collectionActionsProps?”

optional collectionActionsProps: COL_ACTIONS_PROPS

CollectionActionsStart?

Section titled “CollectionActionsStart?”

optional CollectionActionsStart: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS>[]

collectionActionsStartProps?

Section titled “collectionActionsStartProps?”

optional collectionActionsStartProps: COL_ACTIONS_START__PROPS

HeaderAction?

Section titled “HeaderAction?”

optional HeaderAction: React.ComponentType<{ collection: EC; fullPath: string; onHover: boolean; parentCollectionIds: string[]; property: ResolvedProperty; propertyKey: string; tableController: EntityTableController; }>

Use this method to inject widgets to the entity collections header

Param
Section titled “Param”

onTextSearchClick()?

Section titled “onTextSearchClick()?”

optional onTextSearchClick: (props) => Promise<boolean>

Parameters
Section titled “Parameters”
props
Section titled “props”
collection
Section titled “collection”

EC

context
Section titled “context”

FireCMSContext

parentCollectionIds?
Section titled “parentCollectionIds?”

string[]

path
Section titled “path”

string

Returns
Section titled “Returns”

Promise<boolean>

showTextSearchBar()?

Section titled “showTextSearchBar()?”

optional showTextSearchBar: (props) => boolean

Parameters
Section titled “Parameters”
props
Section titled “props”
collection
Section titled “collection”

EC

context
Section titled “context”

FireCMSContext

parentCollectionIds?
Section titled “parentCollectionIds?”

string[]

path
Section titled “path”

string

Returns
Section titled “Returns”

boolean

form?

Section titled “form?”

optional form: object

Defined in: types/plugins.tsx:166

Actions?

Section titled “Actions?”

optional Actions: React.ComponentType<PluginFormActionProps<any, EC>>

Add custom actions to the default ones (“Save”, “Discard”…)

ActionsTop?

Section titled “ActionsTop?”

optional ActionsTop: React.ComponentType<PluginFormActionProps<any, EC>>

Add custom actions to the top of the form

fieldBuilder()?

Section titled “fieldBuilder()?”

optional fieldBuilder: <T>(props) => React.ComponentType<FieldProps<T>> | null

Type Parameters
Section titled “Type Parameters”
T
Section titled “T”

T extends CMSType = CMSType

Parameters
Section titled “Parameters”
props
Section titled “props”

PluginFieldBuilderParams<T, any, EC>

Returns
Section titled “Returns”

React.ComponentType<FieldProps<T>> | null

fieldBuilderEnabled()?

Section titled “fieldBuilderEnabled()?”

optional fieldBuilderEnabled: <T>(props) => boolean

Type Parameters
Section titled “Type Parameters”
T
Section titled “T”

T extends CMSType = CMSType

Parameters
Section titled “Parameters”
props
Section titled “props”

PluginFieldBuilderParams<T>

Returns
Section titled “Returns”

boolean

provider?

Section titled “provider?”

optional provider: object

provider.Component
Section titled “provider.Component”

Component: React.ComponentType<PropsWithChildren<FORM_PROPS & PluginFormActionProps<any, EC>>>

provider.props?
Section titled “provider.props?”

optional props: FORM_PROPS

homePage?

Section titled “homePage?”

optional homePage: object

Defined in: types/plugins.tsx:49

additionalActions?

Section titled “additionalActions?”

optional additionalActions: React.ReactNode

Additional actions to be rendered in the home page, close to the search bar.

AdditionalCards?

Section titled “AdditionalCards?”

optional AdditionalCards: React.ComponentType<PluginHomePageAdditionalCardsProps> | React.ComponentType<PluginHomePageAdditionalCardsProps>[]

Add additional cards to each collection group in the home page.

additionalChildrenEnd?

Section titled “additionalChildrenEnd?”

optional additionalChildrenEnd: React.ReactNode

Additional children to be rendered at the end of the home page.

additionalChildrenStart?

Section titled “additionalChildrenStart?”

optional additionalChildrenStart: React.ReactNode

Additional children to be rendered in the beginning of the home page.

allowDragAndDrop?

Section titled “allowDragAndDrop?”

optional allowDragAndDrop: boolean

Allow reordering with drag and drop of the collections in the home page.

CollectionActions?

Section titled “CollectionActions?”

optional CollectionActions: React.ComponentType<PluginHomePageActionsProps>

Use this component to add custom actions to the navigation card in the home page.

extraProps?

Section titled “extraProps?”

optional extraProps: any

Additional props passed to CollectionActions

includeSection()?

Section titled “includeSection()?”

optional includeSection: (props) => object

Include a section in the home page with a custom component and title.

Parameters
Section titled “Parameters”
props
Section titled “props”

PluginGenericProps

Returns
Section titled “Returns”

object

children
Section titled “children”

children: React.ReactNode

title
Section titled “title”

title: string

Section titled “navigationEntries?”

optional navigationEntries: NavigationGroupMapping[]

onNavigationEntriesUpdate()?

Section titled “onNavigationEntriesUpdate()?”

optional onNavigationEntriesUpdate: (entries) => void

This method will be called when the entries are updated in the home page. group => navigationEntriesOrder (path)

Parameters
Section titled “Parameters”
entries
Section titled “entries”

NavigationGroupMapping[]

Returns
Section titled “Returns”

void

key

Section titled “key”

key: string

Defined in: types/plugins.tsx:23

Key of the plugin. This is used to identify the plugin in the CMS.

loading?

Section titled “loading?”

optional loading: boolean

Defined in: types/plugins.tsx:29

If this flag is set to true, no content will be shown in the CMS until the plugin is fully loaded.

provider?

Section titled “provider?”

optional provider: object

Defined in: types/plugins.tsx:40

You can use this prop to add higher order components to the CMS. The components will be added to the root of the CMS, so any component rendered underneath by this plugin will have access to the context provided by this HOC. Anyhow, this is rendered below the FireCMSContext provider, so you can use the hooks provided by the CMS.

Component

Section titled “Component”

Component: React.ComponentType<PropsWithChildren<PROPS & object>>

props?

Section titled “props?”

optional props: PROPS

Param

Section titled “Param”

userManagement?

Section titled “userManagement?”

optional userManagement: InternalUserManagement

Defined in: types/plugins.tsx:47