IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
e2038e0614
grafana/packages/grafana-ui
History
Marcus Andersson e2038e0614
Docs: adding API reference documentation support for the packages libraries. (#21931) 
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added parameters and return values.

* Fixed merge error.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* lerna bootstrap.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.
2020-02-25 13:59:11 +01:00
..
.storybook Storybook: Add color theme and theme switcher (#22005) 2020-02-17 10:36:16 +01:00
src Docs: adding API reference documentation support for the packages libraries. (#21931) 2020-02-25 13:59:11 +01:00
.eslintrc TSLint → ESLint (#21006) 2020-02-08 02:40:04 +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 Changelog: v6.6.0-beta1 (#21619) 2020-01-21 10:10:16 +01:00
index.js Implemented scripts for building and releasing grafana/ui 2019-02-21 15:06:29 +01:00
package.json Docs: adding API reference documentation support for the packages libraries. (#21931) 2020-02-25 13:59:11 +01:00
README.md Packages: update versioning and release process (#18195) 2019-09-12 08:00:31 +02:00
rollup.config.ts grafana/ui: Do not build in strict mode as grafana/ui depends on non-strict libs (#21319) 2020-01-03 10:02:27 +01:00
tsconfig.build.json TSLint → ESLint (#21006) 2020-02-08 02:40:04 +01:00
tsconfig.json TSLint → ESLint (#21006) 2020-02-08 02:40:04 +01:00

README.md

Grafana UI components library

@grafana/toolkit is currently in ALPHA. Core API is unstable and can be a subject of breaking changes!

@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.