IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-22 08:56:43 -06:00
Code Issues Packages Projects Releases Wiki Activity
620cc52863
grafana/packages/grafana-ui
History
Ashley Harrison ba6d2f2a82
Chore: improve some more types (#60476) 
* improve some more types

* fixes

Co-authored-by: Zoltán Bedi <zoltan.bedi@gmail.com>
2022-12-20 13:07:57 +00:00
..
.storybook Chore: remove @storybook/addon-knobs package (#60524) 2022-12-19 15:35:32 +00:00
scripts Icons: Move unicons icons to the repository and generate the iconsBundle.js with nodejs (#53766) 2022-08-23 15:47:14 +02:00
src Chore: improve some more types (#60476) 2022-12-20 13:07:57 +00:00
.eslintrc I18n: Add lint rule to enforce correct i18n imports (#56487) 2022-10-07 11:46:28 +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
LICENSE_APACHE2 Re-license Grafana to AGPLv3 (#33184) 2021-04-20 19:03:30 +02:00
package.json Chore: remove @storybook/addon-knobs package (#60524) 2022-12-19 15:35:32 +00:00
README.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
rollup.config.ts Build: Introduce ESM and Treeshaking to NPM package builds (#51517) 2022-08-03 15:47:09 +02:00
tsconfig.build.json Chore: Update slate and related packages (#54566) 2022-09-06 15:23:48 +01:00
tsconfig.json Storybook: Fix asset paths for hosted storybooks (#56319) 2022-10-05 12:10:29 +02: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.