3.8 KiB
id, title, sidebar_label, sidebar_position, custom_edit_url
| id | title | sidebar_label | sidebar_position | custom_edit_url |
|---|---|---|---|---|
| cmsappproviderprops | Interface: CMSAppProviderProps | CMSAppProviderProps | 0 | null |
Main entry point that defines the CMS configuration
Properties
authentication
• Optional authentication: boolean | Authenticator
Do the users need to log in to access the CMS. You can specify an Authenticator function to discriminate which users can access the CMS or not. If not specified, authentication is enabled but no user restrictions apply
Defined in
dateTimeFormat
• Optional dateTimeFormat: string
Format of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss'
Defined in
firebaseConfig
• firebaseConfig: Object
Firebase configuration of the project. This component is not in charge of initialising Firebase and expects it to be already initialised.
Defined in
fontFamily
• Optional fontFamily: string
Font family string e.g. '"Roboto", "Helvetica", "Arial", sans-serif'
Defined in
locale
• Optional locale: Locale
Locale of the CMS, currently only affecting dates
Defined in
navigation
• navigation: EntityCollectionView<EntitySchema<any, any>, any, string>[] | Navigation | NavigationBuilder
Use this prop to specify the views that will be generated in the CMS.
You usually will want to create a Navigation object that includes
collection views where you specify the path and the schema.
Additionally you can add custom views to the root navigation.
In you need to customize the navigation based on the logged user you
can use a NavigationBuilder
Defined in
primaryColor
• Optional primaryColor: string
Primary color of the theme of the CMS
Defined in
schemaResolver
• Optional schemaResolver: SchemaResolver
Used to override schemas based on the collection path and entityId. This resolver allows to override the schema for specific entities, or specific collections, app wide. This overrides schemas all through the app.
You can also override schemas in place, when using useSideEntityController
Defined in
secondaryColor
• Optional secondaryColor: string
Secondary color of the theme of the CMS
Defined in
signInOptions
• Optional signInOptions: any[]
List of sign in options that will be displayed in the login
view if authentication is enabled. You can pass google providers strings,
such as firebase.auth.GoogleAuthProvider.PROVIDER_ID or full configuration
objects such as specified in https://firebase.google.com/docs/auth/web/firebaseui
Defaults to Google sign in only.