IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-29 20:24:18 -06:00
Code Issues Packages Projects Releases Wiki Activity
70d7b3fc55
grafana/packages/grafana-ui
History
Jack Westbrook 7df591442e
Docs: fix grafana/ui docsExtract REF_NOT_FOUND errors (#33905) 
* fix(grafana-ui): re-export commonOptionsBuilder namespace for api-extractor to work

* docs(grafana-ui): add docblock annotations for exported interfaces

* docs(grafana-ui): export ScaleDistribution from uplot
2021-05-11 14:45:46 +02:00
..
.storybook Theme: Renames new theme model from GrafanaThemeV2 to just GrafanaTheme (#33619) 2021-05-03 09:45:54 +02:00
src Docs: fix grafana/ui docsExtract REF_NOT_FOUND errors (#33905) 2021-05-11 14:45:46 +02:00
.eslintrc Chore: Restrict internal imports from other packages (#30453) 2021-01-21 09:04:31 +01:00
api-extractor.json Docs: adding API reference documentation support for the packages libraries. (#21931) 2020-02-25 13:59:11 +01:00
CHANGELOG.md Update changelog (#28292) 2020-10-15 18:11:48 +02:00
index.js Chore: MEGA - Make Eslint Great Again 💅 (#26094) 2020-08-11 17:52:44 +02:00
LICENSE_APACHE2 Re-license Grafana to AGPLv3 (#33184) 2021-04-20 19:03:30 +02:00
package.json Fix dead key issue in slate (#33545) 2021-05-05 15:22:00 +02:00
README.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
rollup.config.ts SigV4: Add support EC2 IAM role auth and possibility to toggle auth providers (#32444) 2021-03-30 12:30:34 +02:00
tsconfig.build.json Move NOOP_CONTROL to storybook utils and change to a standalone file (#31421) 2021-02-23 15:20:07 +01:00
tsconfig.json Grafana-UI: Switch CodeEditor to UMD @monao-editor/react (#33204) 2021-04-27 17:34:56 +01:00

README.md

Grafana UI components library

@grafana/ui is currently in BETA.

@grafana/ui is a collection of components used by Grafana

Our goal is to deliver Grafana's common UI elements for plugins developers and contributors.

Browse the Storybook catalog of the components.

See package source for more details.

Installation

yarn add @grafana/ui

npm install @grafana/ui

Development

For development purposes we suggest using yarn link that will create symlink to @grafana/ui lib. To do so navigate to packages/grafana-ui and run yarn link. Then, navigate to your project and run yarn link @grafana/ui to use the linked version of the lib. To unlink follow the same procedure, but use yarn unlink instead.

Storybook 6.x migration

We've upgraded Storybook to version 6 and with that we will convert to using controls instead of knobs for manipulating components. Controls will not require as much coding as knobs do. Please refer to the storybook style-guide for further information.