Type Alias: FireCMSProps<UserType, EC>

FireCMSProps<UserType, EC>: object

Type Parameters

• UserType extends User

• EC extends EntityCollection

Type declaration

authController

authController: AuthController<UserType>

Delegate for implementing your auth operations.

children()

children: (props) => React.ReactNode

Use this function to return the components you want to render under FireCMS

Parameters

• props

• props.context: FireCMSContext

Context of the app

• props.loading: boolean

Is one of the main processes, auth and navigation resolving, currently loading. If you are building your custom implementation, you probably want to show a loading indicator if this flag is true

Returns

React.ReactNode

components?

optional components: object

components.missingReference?

optional missingReference: React.ComponentType<object>

Component to render when a reference is missing

Type declaration

path

path: string

dataSourceDelegate

dataSourceDelegate: DataSourceDelegate

Connector to your database

dateTimeFormat?

optional dateTimeFormat: string

Format of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss'

entityLinkBuilder?

optional entityLinkBuilder: EntityLinkBuilder

Optional link builder you can add to generate a button in your entity forms. The function must return a URL that gets opened when the button is clicked

entityViews?

optional entityViews: EntityCustomView[]

List of additional custom views for entities. You can use the key to reference the custom view in the entityViews prop of a collection.

You can also define an entity view from the UI.

locale?

optional locale: Locale

Locale of the CMS, currently only affecting dates

navigationController

navigationController: NavigationController

This controller is in charge of the navigation of the CMS. It is in charge of resolving the collection and entity paths.

onAnalyticsEvent()?

optional onAnalyticsEvent: (event, data?) => void

Callback used to get analytics events from the CMS

Parameters

• event: CMSAnalyticsEvent

• data?: object

Returns

void

plugins?

optional plugins: FireCMSPlugin<any, any, any>[]

Use plugins to modify the behaviour of the CMS. Currently, in ALPHA, and likely subject to change.

propertyConfigs?

optional propertyConfigs: Record<string, PropertyConfig>

Record of custom form fields to be used in the CMS. You can use the key to reference the custom field in the propertyConfig prop of a property in a collection.

storageSource

storageSource: StorageSource

Connector to your file upload/fetch implementation

userConfigPersistence?

optional userConfigPersistence: UserConfigurationPersistence

Use this controller to access the configuration that is stored locally, and not defined in code

Defined in

packages/firecms_core/src/types/firecms.tsx:50