mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
2.8 KiB
2.8 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "NavModelItem" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
NavModelItem interface
Signature
export interface NavModelItem
Import
import { NavModelItem } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| active | boolean |
|
| breadcrumbs | NavModelBreadcrumb[] |
|
| children | NavModelItem[] |
|
| divider | boolean |
|
| hideFromMenu | boolean |
|
| hideFromTabs | boolean |
|
| icon | string |
|
| id | string |
|
| img | string |
|
| parentItem | NavModelItem |
|
| showOrgSwitcher | boolean |
|
| subTitle | string |
|
| target | string |
|
| text | string |
|
| url | string |
active property
Signature
active?: boolean;
breadcrumbs property
Signature
breadcrumbs?: NavModelBreadcrumb[];
children property
Signature
children?: NavModelItem[];
divider property
Signature
divider?: boolean;
hideFromMenu property
Signature
hideFromMenu?: boolean;
hideFromTabs property
Signature
hideFromTabs?: boolean;
icon property
Signature
icon?: string;
id property
Signature
id?: string;
img property
Signature
img?: string;
parentItem property
Signature
parentItem?: NavModelItem;
showOrgSwitcher property
Signature
showOrgSwitcher?: boolean;
subTitle property
Signature
subTitle?: string;
target property
Signature
target?: string;
text property
Signature
text: string;
url property
Signature
url?: string;