mirror of https://github.com/grafana/grafana.git synced 2024-12-01 13:09:22 -06:00

History

kay delaney 47d2a8085b Frontend changes for library panels feature (#30653 ) Co-authored-by: Hugo Häggmark <hugo.haggmark@gmail.com>		2021-02-25 10:26:28 +00:00
..
.storybook	Move NOOP_CONTROL to storybook utils and change to a standalone file (#31421 )	2021-02-23 15:20:07 +01:00
src	Frontend changes for library panels feature (#30653 )	2021-02-25 10:26:28 +00: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	Update changelog (#28292 )	2020-10-15 18:11:48 +02:00
index.js	Chore: MEGA - Make Eslint Great Again 💅 (#26094 )	2020-08-11 17:52:44 +02:00
package.json	Revert ""Release: Updated versions in package to 7.4.3" (#31444 )" (#31452 )	2021-02-24 17:53:08 +01:00
README.md	Chore: Bump storybook to v6 (#28926 )	2020-11-24 10:38:41 +01:00
rollup.config.ts	Chore: bump rollup across all packages (#29486 )	2021-01-12 16:51:09 +01:00
tsconfig.build.json	Move NOOP_CONTROL to storybook utils and change to a standalone file (#31421 )	2021-02-23 15:20:07 +01:00
tsconfig.json	Storybook: Use bare specifier @grafana/ui in public stories (#26563 )	2020-07-24 16:41:44 +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.

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.