f4ae0cfaa8
* grafana/master: fix(explore/logs) not collapsing whitespace (#15737) Refactoring / fixing password hint PR #15868 chore: Move sidemenu out of context service and use the logic we have in the router already for hiding the sidemenu Fix deduplication results displaying wrong data (#15755) Revert "Fix Datasource Update to no User/Password" fix imageurl in notification test changed all rems to pixels in defaults and template, changed back root font size Make password hint configurable from settings/defaults.ini changed root font to 100%(default 16px), changed font-size from px to rem, updated rem sizes in template and default.ts files, removed display classes and variables since not used, removed lead class and variables since not usedremoved serif font since not used and probably never should be used fix: Update test snapshot fix: Logo goes Home instead of toggling side menu #15482 Fix: #14706 Incorrect index pattern padding in alerting queries Removed commented code Fixed alias in Cloudwatch Expressions |
||
|---|---|---|
| .. | ||
| .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.