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

History

Ryan McKinley dfda3e2b03 Dependencies: Update monaco-editor (#54068 ) Co-authored-by: Gábor Farkas <gabor.farkas@gmail.com>		2022-08-23 06:58:58 -07:00
..
.storybook	Build: Introduce ESM and Treeshaking to NPM package builds (#51517 )	2022-08-03 15:47:09 +02: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	Dependencies: Update monaco-editor (#54068 )	2022-08-23 06:58:58 -07: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
LICENSE_APACHE2	Re-license Grafana to AGPLv3 (#33184 )	2021-04-20 19:03:30 +02:00
package.json	Dependencies: Update monaco-editor (#54068 )	2022-08-23 06:58:58 -07: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	Grafana UI: Prevent mandatory css prop in bundled types (#42216 )	2021-11-24 14:35:06 +01:00
tsconfig.json	Build: Introduce ESM and Treeshaking to NPM package builds (#51517 )	2022-08-03 15:47:09 +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.