mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 12:14:08 -06:00
c2c1ec7d0f
* Chore: Move from master branch to main Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com> * CI: Upgrade build pipeline tool to v2 Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
# Grafana UI components library
|
|
|
|
> **@grafana/ui is currently in BETA**.
|
|
|
|
@grafana/ui is a collection of components used by [Grafana](https://github.com/grafana/grafana)
|
|
|
|
Our goal is to deliver Grafana's common UI elements for plugins developers and contributors.
|
|
|
|
Browse the [Storybook catalog of the components](http://developers.grafana.com/).
|
|
|
|
See [package source](https://github.com/grafana/grafana/tree/main/packages/grafana-ui) 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](https://storybook.js.org/docs/react/essentials/controls) instead of knobs for manipulating components. Controls will not require as much coding as knobs do. Please refer to the [storybook style-guide](https://github.com/grafana/grafana/blob/main/contribute/style-guides/storybook.md#contrls) for further information.
|