mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 10:52:40 +08: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.
65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "AppRootProps"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## AppRootProps interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface AppRootProps<T = KeyValue>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { AppRootProps } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [meta](#meta-property) | <code>AppPluginMeta<T></code> | |
|
|
| [onNavChanged](#onnavchanged-property) | <code>(nav: NavModel) => void</code> | Pass the nav model to the container... is there a better way? |
|
|
| [path](#path-property) | <code>string</code> | |
|
|
| [query](#query-property) | <code>KeyValue</code> | |
|
|
|
|
### meta property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
meta: AppPluginMeta<T>;
|
|
```
|
|
|
|
### onNavChanged property
|
|
|
|
Pass the nav model to the container... is there a better way?
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
onNavChanged: (nav: NavModel) => void;
|
|
```
|
|
|
|
### path property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
path: string;
|
|
```
|
|
|
|
### query property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
query: KeyValue;
|
|
```
|