Interface: FireCMSProps<UserType>
Type parameters​
| Name | Type |
|---|---|
UserType | extends User |
Properties​
EntityCollectionViewComponent​
• Optional EntityCollectionViewComponent: ComponentType<EntityCollectionViewProps<any>>
Component used to render a collection view. Defaults to EntityCollectionView
Defined in​
authDelegate​
• authDelegate: AuthDelegate<UserType>
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​
collectionOverrideHandler​
• Optional collectionOverrideHandler: CollectionOverrideHandler
Used to override collections based on the collection path and entityId. This resolver allows to override the collection for specific entities, or specific collections, app wide.
This overrides collections all through the app.
You can also override collections in place, when using useSideEntityController
Defined in​
collections​
• Optional collections: EntityCollection<any, string, User>[] | EntityCollectionsBuilder
List of the mapped collections in the CMS. Each entry relates to a collection in the root database. Each of the navigation entries in this field generates an entry in the main menu.
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​
storageSource​
• storageSource: StorageSource
Connector to your file upload/fetch implementation
Defined in​
userConfigPersistence​
• Optional userConfigPersistence: UserConfigurationPersistence
Use this controller to access the configuration that is stored locally, and not defined in code
Defined in​
views​
• Optional views: CMSView[] | CMSViewsBuilder
Custom additional views created by the developer, added to the main navigation
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<User> | 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 | "light" | "dark" | Main color scheme |
Returns​
ReactNode