343e49decb
* grafana/master: (24 commits) docs: Fix indentation level for OAuth2 config docs: update CONTRIBUTING.md @grafana/ui - release docs v1 (#15835) Minor refactoring of copy tags when saving feature, #15446 Simple implementation for preserve tags, closes #11627 Updated prettierignore Refactoring of PR #14772 fix typo in pr template add nil/length check when delete old login attempts Minor refactoring of new react text panel fix allow anonymous server bind for ldap search use pure component use replaceVariables Catch bad regex exception at controller level 11780: invalid reg value can cause unexpected behaviour update Add string quote func Remove option used to control within browser Add pic into actionCard message Add new option to set where to open the message url ... |
||
|---|---|---|
| .. | ||
| .storybook | ||
| src | ||
| CHANGELOG.md | ||
| index.js | ||
| package.json | ||
| README.md | ||
| rollup.config.ts | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tslint.json | ||
Grafana UI components library
@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.
Building @grafana/ui
To build @grafana/ui run npm run gui:build script from Grafana repository root. The build will be created in packages/grafana-ui/dist directory. Following steps from Development you can test built package.
Releasing new version
To release new version run npm run gui:release script from Grafana repository root. The script will prepare the distribution package as well as prompt you to bump library version and publish it to the NPM registry.
Automatic version bump
When running npm run gui:release package.json file will be automatically updated. Also, package.json file will be commited and pushed to upstream branch.
Manual version bump
To use package.json defined version run npm run gui:release --usePackageJsonVersion from Grafana repository root.
Preparing release package without publishing to NPM registry
For testing purposes there is npm run gui:releasePrepare task that prepares distribution package without publishing it to the NPM registry.
V1 release process overview
- Package is compiled with TSC. Typings are created in
/distdirectory, and the compiled js lands in/compileddir - Rollup creates a CommonJS package based on compiled sources, and outputs it to
/distdirectory - Readme, changelog and index.js files are moved to
/distdirectory - Package version is bumped in both
@grafana/uipackage dir and in dist directory. - Version commit is created and pushed to master branch
- Package is published to npm
Versioning
To limit the confusion related to @grafana/ui and Grafana versioning we decided to keep the major version in sync between those two. This means, that first version of @grafana/ui is taged with 6.0.0-alpha.0 to keep version in sync with Grafana 6.0 release.