History

Steven Vachon 2b6a88bf59 Optimized package.json files (#22475 ) * Used repository shortcut syntax where possible * Added repository directories for monorepo packages * Alphabetically sorted npm scripts		2020-02-27 12:00:36 -05:00
..
.storybook	Storybook: Add color theme and theme switcher (#22005 )	2020-02-17 10:36:16 +01:00
src	Grafana UI: Add forwardRef (#22466 )	2020-02-27 12:24:36 +02:00
.eslintrc	…
CHANGELOG.md	…
README.md	…
api-extractor.json	Docs: adding API reference documentation support for the packages libraries. (#21931 )	2020-02-25 13:59:11 +01:00
index.js	…
package.json	Optimized package.json files (#22475 )	2020-02-27 12:00:36 -05:00
rollup.config.ts	…
tsconfig.build.json	…
tsconfig.json	…

README.md

Grafana UI components library

@grafana/toolkit is currently in ALPHA. Core API is unstable and can be a subject of breaking changes!

@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.

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.