BuildNavigationContextProps
@firecms/core / BuildNavigationContextProps
Type Alias: BuildNavigationContextProps<EC, USER>
Section titled “Type Alias: BuildNavigationContextProps<EC, USER>”BuildNavigationContextProps<
EC,USER> =object
Defined in: hooks/useBuildNavigationController.tsx:40
Type Parameters
Section titled “Type Parameters”EC extends EntityCollection
USER extends User
Properties
Section titled “Properties”adminViews?
Section titled “adminViews?”
optionaladminViews:CMSView[] |CMSViewsBuilder
Defined in: hooks/useBuildNavigationController.tsx:77
Custom views to be added to the CMS admin navigation. This can be a static array of views or a function that returns a promise resolving to an array of views.
authController
Section titled “authController”authController:
AuthController<USER>
Defined in: hooks/useBuildNavigationController.tsx:54
The auth controller used to manage the user authentication and permissions.
baseCollectionPath?
Section titled “baseCollectionPath?”
optionalbaseCollectionPath:string
Defined in: hooks/useBuildNavigationController.tsx:50
Base path for the collections, used to build the collection URLs. Defaults to “c” (e.g. “/c/products”).
basePath?
Section titled “basePath?”
optionalbasePath:string
Defined in: hooks/useBuildNavigationController.tsx:45
Base path for the CMS, used to build the all the URLs. Defaults to ”/“.
collectionPermissions?
Section titled “collectionPermissions?”
optionalcollectionPermissions:PermissionsBuilder
Defined in: hooks/useBuildNavigationController.tsx:65
Optional permissions builder to be applied to the collections. If not provided, the permissions will be resolved from the collection configuration.
collections?
Section titled “collections?”
optionalcollections:EC[] |EntityCollectionsBuilder<EC>
Defined in: hooks/useBuildNavigationController.tsx:60
The collections to be used in the CMS. This can be a static array of collections or a function that returns a promise resolving to an array of collections.
dataSourceDelegate
Section titled “dataSourceDelegate”dataSourceDelegate:
DataSourceDelegate
Defined in: hooks/useBuildNavigationController.tsx:85
Delegate for data source operations, used to resolve collections and views.
disabled?
Section titled “disabled?”
optionaldisabled:boolean
Defined in: hooks/useBuildNavigationController.tsx:97
If true, the navigation logic will not be updated until this flag is false
navigationGroupMappings?
Section titled “navigationGroupMappings?”
optionalnavigationGroupMappings:NavigationGroupMapping[]
Defined in: hooks/useBuildNavigationController.tsx:93
Used to define the name of groups and order of the navigation entries.
plugins?
Section titled “plugins?”
optionalplugins:FireCMSPlugin[]
Defined in: hooks/useBuildNavigationController.tsx:89
Plugins to be used in the CMS.
userConfigPersistence?
Section titled “userConfigPersistence?”
optionaluserConfigPersistence:UserConfigurationPersistence
Defined in: hooks/useBuildNavigationController.tsx:81
Controller for storing user preferences.
views?
Section titled “views?”
optionalviews:CMSView[] |CMSViewsBuilder
Defined in: hooks/useBuildNavigationController.tsx:71
Custom views to be added to the CMS, these will be available in the main navigation. This can be a static array of views or a function that returns a promise resolving to an array of views.
viewsOrder?
Section titled “viewsOrder?”
optionalviewsOrder:string[]
Defined in: hooks/useBuildNavigationController.tsx:103
Deprecated
Section titled “Deprecated”Use navigationGroupMappings instead.
