grafana/packages/grafana-ui
Chi-Hsuan Huang 73518bf1e7
Chore: Enable remaining eslint-plugin-react rules (#29519)
* Chore: Enable eslint react/no-render-return-value rule

Eanble the rule and remove the unused render return

part of: #29201

* Chore: Enable eslint react/no-children-prop rule

Not linting issues after turning on this. No other file changes requried

part of: #29201

* Chore: Enable eslint react/no-unknown-property rule

Correct enable-background to enableBackground

part of: #29201

* Chore: Enable eslint react/no-unescaped-entities rule

Replaced " with " replaced ' with '

part of: #29201
2020-12-02 10:03:37 +01:00
..
.storybook Chore: Bump storybook to v6 (#28926) 2020-11-24 10:38:41 +01:00
src Chore: Enable remaining eslint-plugin-react rules (#29519) 2020-12-02 10:03:37 +01:00
.eslintrc Chore: Bump storybook to v6 (#28926) 2020-11-24 10:38:41 +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 Jest: Upgrade to latest (#29450) 2020-11-29 08:32:26 +01:00
README.md Chore: Bump storybook to v6 (#28926) 2020-11-24 10:38:41 +01:00
rollup.config.ts Chore: bump grafana-ui rollup dependencies (#29315) 2020-11-29 08:05:23 +01:00
tsconfig.build.json TSLint → ESLint (#21006) 2020-02-08 02:40:04 +01:00
tsconfig.json Storybook: Use bare specifier @grafana/ui in public stories (#26563) 2020-07-24 16:41:44 +02: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.

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.