Type alias: NavigationContext

Ƭ NavigationContext: Object

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

Type declaration

Name	Type	Description
baseCollectionPath	string	Default path under the collection routes of the CMS will be created
baseLocation	string	Location used as the base for routes. This is the location that will be used underneath, when the url changes while opening a side dialog
basePath	string	Default path under the navigation routes of the CMS will be created
collections	EntityCollection[]	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.
homeUrl	string	Base url path for the home screen
initialised	boolean	Is the registry ready to be used
loading	boolean	Is the navigation loading (the configuration persistence has not loaded yet, or a specified navigation builder has not completed)
navigationLoadingError?	any	Was there an error while loading the navigation data
topLevelNavigation?	TopNavigationResult	Configuration for the views that should be displayed at the top level of the navigation (e.g. in the home page or the navigation drawer)
views	CMSView[]	Custom additional views created by the developer, added to the main navigation
buildCMSUrlPath	(path: string) => string	Convert a collection or entity path to a URL path
buildUrlCollectionPath	(path: string) => string	Build a URL collection path from a data path products => /c/products products/B34SAP8Z => /c/products/B34SAP8Z
buildUrlEditCollectionPath	(props: { path: string }) => string	-
getCollection	<M>(path: string, entityId?: string, includeUserOverride?: boolean) => undefined | EntityCollection<M, string, User>	Get the collection configuration for a given path. If you use this method you can use a baseCollection that will be used to resolve the initial properties of the collection, before applying the collection configuration changes that are persisted. If you don't specify it, the collection is fetched from the local navigation.
isUrlCollectionPath	(urlPath: string) => boolean	Check if a url path belongs to a collection
resolveAliasesFrom	(pathWithAliases: string) => string	Turn a path with aliases into a resolved path
urlPathToDataPath	(cmsPath: string) => string	Convert a URL path to a collection or entity path /c/products => products /my_cms/c/products/B34SAP8Z => products/B34SAP8Z /my_cms/my_view => my_view

Defined in

lib/src/models/navigation.ts:8