Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.0/packages_api/data/navmodel.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.0/packages_api/data/navmodel/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
NavModel interface
Interface used to describe different kinds of page titles and page navigation. Navmodels are usually generated in the backend and stored in Redux.
Signature
export interface NavModel Import
import { NavModel } from '@grafana/data';Properties
| Property | Type | Description |
|---|---|---|
| breadcrumbs | NavModelItem[] | Describes breadcrumbs that are used in places such as data source settings., folder page and plugins page. |
| main | NavModelItem | Main page. that wraps the navigation. Generate the children property generate tabs when used with the Page component. |
| node | NavModelItem | This is the current active tab/navigation. |
breadcrumbs property
Describes breadcrumbs that are used in places such as data source settings., folder page and plugins page.
Signature
breadcrumbs?: NavModelItem[];main property
Main page. that wraps the navigation. Generate the children property generate tabs when used with the Page component.
Signature
main: NavModelItem;node property
This is the current active tab/navigation.
Signature
node: NavModelItem;