Interface: FireCMSProps<UserType>
Type parameters​
| Name |
|---|
UserType |
Properties​
authDelegate​
• authDelegate: AuthDelegate<any>
Delegate for implementing your auth operations.
see useFirebaseAuthDelegate
Defined in​
authentication​
• Optional authentication: boolean | Authenticator<UserType>
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​
baseCollectionPath​
• Optional baseCollectionPath: string
Default path under the collection routes of the CMS will be created
Defined in​
basePath​
• Optional basePath: string
Default path under the navigation routes of the CMS will be created
Defined in​
dataSource​
• dataSource: DataSource
Connector to your database
Defined in​
dateTimeFormat​
• Optional dateTimeFormat: string
Format of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss'
Defined in​
entityLinkBuilder​
• Optional entityLinkBuilder: EntityLinkBuilder<any>
Optional link builder you can add to generate a button in your entity forms. The function must return a URL that gets opened when the button is clicked
Defined in​
locale​
• Optional locale: Locale
Locale of the CMS, currently only affecting dates
Defined in​
navigation​
• navigation: Navigation | NavigationBuilder<UserType> | EntityCollection<any, string, any>[]
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​
schemaOverrideHandler​
• Optional schemaOverrideHandler: SchemaOverrideHandler
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​
storageSource​
• storageSource: StorageSource
Connector to your file upload/fetch implementation
Defined in​
Methods​
children​
â–¸ children(props): ReactNode
Use this function to return the components you want to render under FireCMS
Parameters​
| Name | Type | Description |
|---|---|---|
props | Object | |
props.context | FireCMSContext<any> | Context of the app |
props.loading | boolean | Is one of the main processes, auth and navigation resolving, currently loading. If you are building your custom implementation, you probably want to show a loading indicator if this flag is true |
props.mode | "dark" | "light" | Main color scheme |
Returns​
ReactNode