IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-29 20:24:18 -06:00
Code Issues Packages Projects Releases Wiki Activity
11c848f00d
grafana/packages/grafana-ui/README.md

26 lines
1.3 KiB
Markdown
Raw Normal View History

Update grafana/ui readme
2019-02-21 10:45:52 -06:00
# Grafana UI components library
wip: moving react graph component to grafana/ui
2018-12-24 07:14:06 -06:00
Storybook: Add intro and reorganize (#23924) * Update Intro * Reorganize stories * Hide panel for ThemeColors * Update packages/grafana-ui/src/components/ColorPicker/ColorPicker.story.mdx Co-Authored-By: Alex Khomenko <Clarity-89@users.noreply.github.com> * Update intro * Hide panel on Icon story * Update README * Add link Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
2020-04-27 08:38:30 -05:00
> **@grafana/ui is currently in BETA**.
Packages: update versioning and release process (#18195)
2019-09-12 01:00:31 -05:00
Update grafana/ui readme
2019-02-21 10:45:52 -06:00
@grafana/ui is a collection of components used by [Grafana](https://github.com/grafana/grafana)
Our goal is to deliver Grafana's common UI elements for plugins developers and contributors.
grafana/ui: added storybook link to readme (#31600)
2021-03-04 03:57:15 -06:00
Browse the [Storybook catalog of the components](http://developers.grafana.com/).
Chore: Move from master to main branch (#33693) * Chore: Move from master branch to main Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com> * CI: Upgrade build pipeline tool to v2 Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-05-06 09:29:29 -05:00
See [package source](https://github.com/grafana/grafana/tree/main/packages/grafana-ui) for more details.
Update grafana/ui readme
2019-02-21 10:45:52 -06:00
## Installation
`yarn add @grafana/ui`
`npm install @grafana/ui`
grafana/ui 6.0.0-alpha.0 release version bump
2019-02-22 04:30:45 -06:00
@grafana/ui - release docs v1 (#15835) * Readme update * Update @grafana/ui Readme qith release process description. Allow version commit creation during release * Run tests and checks for grafana/core before releasing grafana/ui * Post review Readme updates
2019-03-08 07:42:19 -06:00
## 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.
Chore: Bump storybook to v6 (#28926) * Wip * feat: get storybook and app building locally * docs: comment webpack react alias * build(grafana-ui): put back ts-loader * build: prefer storybook essentials over actions and docs. bump dark-mode * chore(storybook): migrate to latest config * build: prevent test env throwing Invalid hook call errors * chore: lodash resolves to package dependency rather than project * use decorators as variable instead of function * perf(storybook): reduce bundling time by splitting type check and compilation * refactor(storybook): use sortOrder.order param to sort intro story first * build: use yarn workspace command * refactor(storybook): use previous knobs addon registration * migrate button story to controls * build(storybook): silence warnings in console * build: bump storybook related ts packages * style: remove trailing whitespace * refactor(graphng): export interface for storybook * controls migration guide * fix typo * docs(storybook): default docs to use dark theme as per current implementation * revert(grafana-ui): put back react-is namedExport this was changed for react 17 bump but causes rollup to fail during bundling * chore: bump storybook to 6.1, enable fastRefresh, silence eslint prop-types * docs(grafana-ui): move knobs -> controls migration guide to storybook style-guide * chore(storybook): silence terminal warning about order of docs addon * Update contribute/style-guides/storybook.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Apply documentation suggestions Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * chore(storybook): bump to 6.1.2 Co-authored-by: Peter Holmberg <peter.hlmbrg@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2020-11-24 03:38:41 -06:00
### Storybook 6.x migration
Chore: Move from master to main branch (#33693) * Chore: Move from master branch to main Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com> * CI: Upgrade build pipeline tool to v2 Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-05-06 09:29:29 -05:00
We've upgraded Storybook to version 6 and with that we will convert to using [controls](https://storybook.js.org/docs/react/essentials/controls) instead of knobs for manipulating components. Controls will not require as much coding as knobs do. Please refer to the [storybook style-guide](https://github.com/grafana/grafana/blob/main/contribute/style-guides/storybook.md#contrls) for further information.
Reference in New Issue Copy Permalink