Skip to main content
Version: 2.0.0-beta

Type alias: FireCMSContext<UserType, AuthControllerType>

Ƭ FireCMSContext<UserType, AuthControllerType>: Object

Context that includes the internal controllers and contexts used by the app. Some controllers and context included in this context can be accessed directly from their respective hooks.

See

useFireCMSContext

Type parameters

NameType
UserTypeextends User = User
AuthControllerTypeextends AuthController<UserType> = AuthController<UserType>

Type declaration

NameTypeDescription
authControllerAuthControllerTypeUsed auth controller
dataSourceDataSourceConnector to your database, e.g. your Firestore database
dateTimeFormat?stringFormat of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss'
entityLinkBuilder?EntityLinkBuilderBuilder for generating utility links for entities
fields?Record<string, FieldConfig>Record of custom form fields to be used in the CMS. You can use the key to reference the custom field in the fieldConfig prop of a property in a collection.
locale?LocaleLocale of the CMS, currently only affecting dates
navigationNavigationContextContext that includes the resolved navigation and utility methods and attributes. See useNavigation
onAnalyticsEvent?(event: CMSAnalyticsEvent, data?: object) => voidCallback used to get analytics events from the CMS
plugins?FireCMSPlugin[]Use plugins to modify the behaviour of the CMS. Currently, in ALPHA, and likely subject to change.
sideDialogsControllerSideDialogsControllerController used to open side dialogs
sideEntityControllerSideEntityControllerController to open the side dialog displaying entity forms See useSideEntityController
snackbarControllerSnackbarControllerUse this controller to display snackbars
storageSourceStorageSourceUsed storage implementation
userConfigPersistence?UserConfigurationPersistenceUse this controller to access data stored in the browser for the user

Defined in

lib/src/types/firecms_context.tsx:23

Need a hand?

Learn how to get the most out of your project with the help of our consulting team.
Get in touch
Sign up to our newsletter to get the latest news and updates. No spam!