grafana/packages/grafana-ui
Hugo Häggmark 44d7d6546f
Variables: Make renamed or missing variable section expandable (#41964)
* Variables: Make renamed or missing variable section expandable

* Chore: feedback after PR comments
2021-11-22 07:38:49 +01:00
..
.storybook Chore: Move babel config to a root babel.config.json (#41615) 2021-11-18 16:38:58 +00:00
src Variables: Make renamed or missing variable section expandable (#41964) 2021-11-22 07:38:49 +01: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 Prettier: Fix all markdown files and add markdown files to CI verify step (#39776) 2021-09-29 14:34:40 +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 Update dependency immutable to v4 (#41238) 2021-11-19 12:02:59 +00:00
README.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
rollup.config.ts Plugins: Mock Icon component to prevent console errors (#39901) 2021-10-01 15:07:22 +02:00
tsconfig.build.json Grafana UI: Fix TS error property css is missing in type (#38078) 2021-08-26 16:00:52 +02:00
tsconfig.json Chore: Switch yarn 2 to plug-n-play strategy (#40300) 2021-10-27 14:21:07 +01:00

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.