mirror of https://github.com/grafana/grafana.git synced 2024-11-27 11:20:27 -06:00

History

renovate[bot] c5be239990 Update dependency @types/jest to v29.5.4 (#63635 ) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>		2023-08-23 11:15:39 +01:00
..
.storybook	Chore: Upgrade Storybook to v7 (#65943 )	2023-05-11 14:26:12 +02:00
scripts
src	Chore: some more type fixes (#73606 )	2023-08-23 10:11:59 +01:00
.eslintrc	Chore: Convert `@grafana/ui` to use emotion object syntax (#71374 )	2023-07-17 16:12:09 +01:00
CHANGELOG.md
LICENSE_APACHE2
package.json	Update dependency @types/jest to v29.5.4 (#63635 )	2023-08-23 11:15:39 +01:00
README.md
rollup.config.ts	Revert "Update dependency rollup to v3 (#58252 )" (#63790 )	2023-02-27 07:01:24 -05:00
tsconfig.build.json	Grafana UI: Ignore internal stories when compiling (#65983 )	2023-04-05 11:47:37 +02:00
tsconfig.json	Chore: Bump d3-color to 3.1.0 (#61609 )	2023-01-26 13:02:22 +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.