IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: allow using both Function and Class components for app plugins (#46148)

Browse Source 
* fix: make it possible to use both class and functional components for plugins

* fix: accept both class and functional components as plugin root pages

* refactor: import types by name

* refactor: use `ComponentType`
This commit is contained in:
Levente Balogh 2022-03-04 09:52:59 +01:00 committed by GitHub
parent c4404982dc
commit c331af93b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/grafana-data/src/types/app.ts
View File

@ -1,4 +1,4 @@
import { ComponentClass } from 'react'; import { ComponentType } from 'react';
import { KeyValue } from './data'; import { KeyValue } from './data';
import { NavModel } from './navModel'; import { NavModel } from './navModel';
import { PluginMeta, GrafanaPlugin, PluginIncludeType } from './plugin'; import { PluginMeta, GrafanaPlugin, PluginIncludeType } from './plugin';
@ -48,7 +48,7 @@ export interface AppPluginMeta<T = KeyValue> extends PluginMeta<T> {
export class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>> { export class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>> {
// Content under: /a/${plugin-id}/* // Content under: /a/${plugin-id}/*
root?: ComponentClass<AppRootProps<T>>; root?: ComponentType<AppRootProps<T>>;
rootNav?: NavModel; // Initial navigation model rootNav?: NavModel; // Initial navigation model
/** /**
@ -66,7 +66,7 @@ export class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>> {
* *
* NOTE: this structure will change in 7.2+ so that it is managed with a normal react router * NOTE: this structure will change in 7.2+ so that it is managed with a normal react router
*/ */
setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel) { setRootPage(root: ComponentType<AppRootProps<T>>, rootNav?: NavModel) {
this.root = root; this.root = root;
this.rootNav = rootNav; this.rootNav = rootNav;
return this; return this;

4
packages/grafana-data/src/types/plugin.ts
View File

@ -1,4 +1,4 @@
import { ComponentClass } from 'react'; import { ComponentType } from 'react';
import { KeyValue } from './data'; import { KeyValue } from './data';
/** Describes plugins life cycle status */ /** Describes plugins life cycle status */
@ -159,7 +159,7 @@ export interface PluginConfigPage<T extends PluginMeta> {
icon?: string; icon?: string;
id: string; // Unique, in URL id: string; // Unique, in URL
body: ComponentClass<PluginConfigPageProps<T>>; body: ComponentType<PluginConfigPageProps<T>>;
} }
export class GrafanaPlugin<T extends PluginMeta = PluginMeta> { export class GrafanaPlugin<T extends PluginMeta = PluginMeta> {