Skip to main content
Version: 3.0.0-beta

Type Alias: FireCMSContext<USER, AuthControllerType>

FireCMSContext<USER, 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.

Type Parameters​

• USER extends User = User

• AuthControllerType extends AuthController<USER> = AuthController<USER>

Type declaration​

analyticsController?​

optional analyticsController: AnalyticsController

Callback to send analytics events

authController​

authController: AuthControllerType

Used auth controller

customizationController​

customizationController: CustomizationController

This controller holds the customization options for the CMS.

dataSource​

dataSource: DataSource

Connector to your database, e.g. your Firestore database

dialogsController​

dialogsController: DialogsController

Controller used to open regular dialogs

navigation: NavigationController

Context that includes the resolved navigation and utility methods and attributes.

See​

useNavigation

sideDialogsController​

sideDialogsController: SideDialogsController

Controller used to open side dialogs This is the controller used internally by side entity dialogs or reference dialogs.

sideEntityController​

sideEntityController: SideEntityController

Controller to open the side dialog displaying entity forms

See​

useSideEntityController

snackbarController​

snackbarController: SnackbarController

Use this controller to display snackbars

storageSource​

storageSource: StorageSource

Used storage implementation

userConfigPersistence?​

optional userConfigPersistence: UserConfigurationPersistence

Use this controller to access data stored in the browser for the user

See​

useFireCMSContext

Defined in​

packages/firecms_core/src/types/firecms_context.tsx:21

Sign up to our newsletter to get the latest news and updates. No spam!