grafana/docs/sources/packages_api/data/navmodel.md
Marcus Andersson a2d741f60f
Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs.

* fixed spelling issues.

* fixed spelling issues.
2020-04-21 10:41:50 +02:00

1.7 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "NavModel" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

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;