Skip to main content
Version: 2.0.0-alpha

Interface: FireCMSContext<UserType>

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

Properties

EntityCollectionViewComponent

EntityCollectionViewComponent: ComponentType<EntityCollectionViewProps<any>>

Component used to render a collection view. Defaults to EntityCollectionView

Defined in

lib/src/models/firecms_context.tsx:86


authController

authController: AuthController<UserType>

Used auth controller

Defined in

lib/src/models/firecms_context.tsx:65


dataSource

dataSource: DataSource

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

Defined in

lib/src/models/firecms_context.tsx:37


dateTimeFormat

Optional dateTimeFormat: string

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

Defined in

lib/src/models/firecms_context.tsx:27


entityLinkBuilder

Optional entityLinkBuilder: EntityLinkBuilder<any>

Builder for generating utility links for entities

Defined in

lib/src/models/firecms_context.tsx:70


locale

Optional locale: Locale

Locale of the CMS, currently only affecting dates

Defined in

lib/src/models/firecms_context.tsx:32


navigation: NavigationContext

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

see useNavigation

Defined in

lib/src/models/firecms_context.tsx:49


sideDialogsController

sideDialogsController: SideDialogsController

Controller used to open side dialogs

Defined in

lib/src/models/firecms_context.tsx:60


sideEntityController

sideEntityController: SideEntityController

Controller to open the side dialog displaying entity forms

see useSideEntityController

Defined in

lib/src/models/firecms_context.tsx:55


snackbarController

snackbarController: SnackbarController

Use this controller to display snackbars

Defined in

lib/src/models/firecms_context.tsx:75


storageSource

storageSource: StorageSource

Used storage implementation

Defined in

lib/src/models/firecms_context.tsx:42


userConfigPersistence

Optional userConfigPersistence: UserConfigurationPersistence

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

Defined in

lib/src/models/firecms_context.tsx:80