FireCMSContext
@firecms/core / FireCMSContext
Type Alias: FireCMSContext<USER, AuthControllerType>
Section titled “Type Alias: FireCMSContext<USER, AuthControllerType>”FireCMSContext<
USER,AuthControllerType> =object
Defined in: types/firecms_context.tsx:22
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.
useFireCMSContext
Type Parameters
Section titled “Type Parameters”AuthControllerType
Section titled “AuthControllerType”AuthControllerType extends AuthController<USER> = AuthController<USER>
Properties
Section titled “Properties”analyticsController?
Section titled “analyticsController?”
optionalanalyticsController:AnalyticsController
Defined in: types/firecms_context.tsx:82
Callback to send analytics events
authController
Section titled “authController”authController:
AuthControllerType
Defined in: types/firecms_context.tsx:62
Used auth controller
customizationController
Section titled “customizationController”customizationController:
CustomizationController
Defined in: types/firecms_context.tsx:67
This controller holds the customization options for the CMS.
dataSource
Section titled “dataSource”dataSource:
DataSource
Defined in: types/firecms_context.tsx:27
Connector to your database, e.g. your Firestore database
dialogsController
Section titled “dialogsController”dialogsController:
DialogsController
Defined in: types/firecms_context.tsx:57
Controller used to open regular dialogs
navigation
Section titled “navigation”navigation:
NavigationController
Defined in: types/firecms_context.tsx:39
Context that includes the resolved navigation and utility methods and attributes.
useNavigation
sideDialogsController
Section titled “sideDialogsController”sideDialogsController:
SideDialogsController
Defined in: types/firecms_context.tsx:52
Controller used to open side dialogs This is the controller used internally by side entity dialogs or reference dialogs.
sideEntityController
Section titled “sideEntityController”sideEntityController:
SideEntityController
Defined in: types/firecms_context.tsx:45
Controller to open the side dialog displaying entity forms
useSideEntityController
snackbarController
Section titled “snackbarController”snackbarController:
SnackbarController
Defined in: types/firecms_context.tsx:72
Use this controller to display snackbars
storageSource
Section titled “storageSource”storageSource:
StorageSource
Defined in: types/firecms_context.tsx:32
Used storage implementation
userConfigPersistence?
Section titled “userConfigPersistence?”
optionaluserConfigPersistence:UserConfigurationPersistence
Defined in: types/firecms_context.tsx:77
Use this controller to access data stored in the browser for the user
userManagement
Section titled “userManagement”userManagement:
InternalUserManagement<USER>
Defined in: types/firecms_context.tsx:98
This section is used to manage users in the CMS. It is used to show user information in various places of the CMS, for example, to show who created or modified an entity, or to assign ownership of an entity.
In the base CMS, this information is not used for access control. You can pass your own implementation of this section, to populate the dropdown of users when assigning ownership of an entity, or to show more information about the user.
If you are using the FireCMS user management plugin, this section will be implemented automatically.
