@grafana/ui/types/app.d.ts

Grafana Components Library

import { ComponentClass } from 'react';
import { NavModel } from '@grafana/data';
import { PluginMeta, GrafanaPlugin, KeyValue } from './plugin';
export interface AppRootProps<T = KeyValue> {
    meta: AppPluginMeta<T>;
    path: string;
    query: KeyValue;
    /**
     * Pass the nav model to the container... is there a better way?
     */
    onNavChanged: (nav: NavModel) => void;
}
export interface AppPluginMeta<T = KeyValue> extends PluginMeta<T> {
}
export declare class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>> {
    root?: ComponentClass<AppRootProps<T>>;
    rootNav?: NavModel;
    angularPages?: {
        [component: string]: any;
    };
    /**
     * Called after the module has loaded, and before the app is used.
     * This function may be called multiple times on the same instance.
     * The first time, `this.meta` will be undefined
     */
    init(meta: AppPluginMeta): void;
    /**
     * Set the component displayed under:
     *   /a/${plugin-id}/*
     */
    setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel): this;
    setComponentsFromLegacyExports(pluginExports: any): void;
}