IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-26 10:50:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
2fe62af685
grafana/packages/grafana-ui
History
An 7b813c81ac
revert: change to events canvas (#38023)
2021-08-18 15:47:25 -04:00
..
.storybook Storybook: Add a11y addon (#36790) 2021-07-22 17:28:38 +02:00
src revert: change to events canvas (#38023) 2021-08-18 15:47:25 -04: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
LICENSE_APACHE2 Re-license Grafana to AGPLv3 (#33184) 2021-04-20 19:03:30 +02:00
package.json Chore: Update NPM packages with react peer deps (#36598) 2021-08-18 11:23:34 +02:00
README.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
rollup.config.ts Grafana-UI: Remove references to old monaco libraries (#35557) 2021-06-22 11:52:08 +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 Grafana-UI: Switch CodeEditor to UMD @monao-editor/react (#33204) 2021-04-27 17:34:56 +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.