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
| Name | Type |
|---|---|
UserType | extends User = User |
AuthControllerType | extends AuthController<UserType> = AuthController<UserType> |
Type declaration
| Name | Type | Description |
|---|---|---|
authController | AuthControllerType | Used auth controller |
dataSource | DataSource | Connector to your database, e.g. your Firestore database |
dateTimeFormat? | string | Format of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss' |
entityLinkBuilder? | EntityLinkBuilder | Builder 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? | Locale | Locale of the CMS, currently only affecting dates |
navigation | NavigationContext | Context that includes the resolved navigation and utility methods and attributes. See useNavigation |
onAnalyticsEvent? | (event: CMSAnalyticsEvent, data?: object) => void | Callback 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. |
sideDialogsController | SideDialogsController | Controller used to open side dialogs |
sideEntityController | SideEntityController | Controller to open the side dialog displaying entity forms See useSideEntityController |
snackbarController | SnackbarController | Use this controller to display snackbars |
storageSource | StorageSource | Used storage implementation |
userConfigPersistence? | UserConfigurationPersistence | Use this controller to access data stored in the browser for the user |