Hosanna Amane
559e74f3e5
|
4 years ago | |
|---|---|---|
| .. | ||
| .storybook | 4 years ago | |
| src | 4 years ago | |
| .eslintrc | 4 years ago | |
| CHANGELOG.md | 4 years ago | |
| LICENSE_APACHE2 | 4 years ago | |
| README.md | 4 years ago | |
| api-extractor.json | 4 years ago | |
| index.js | 4 years ago | |
| package.json | 4 years ago | |
| rollup.config.ts | 4 years ago | |
| tsconfig.build.json | 4 years ago | |
| tsconfig.json | 4 years ago | |
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.