Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@grafana/ui

grafana206.1kApache-2.011.6.1TypeScript support: included

Grafana Components Library

grafana, react, react-component, typescript

readme

Grafana Logo (Light) Grafana Logo (Dark)

The open-source platform for monitoring and observability

License Drone Go Report Card

Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data-driven culture:

  • Visualizations: Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs.
  • Dynamic Dashboards: Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard.
  • Explore Metrics: Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side.
  • Explore Logs: Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live.
  • Alerting: Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie.
  • Mixed Data Sources: Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources.

Get started

Unsure if Grafana is for you? Watch Grafana in action on play.grafana.org!

Documentation

The Grafana documentation is available at grafana.com/docs.

Contributing

If you're interested in contributing to the Grafana project:

Get involved

This project is tested with BrowserStack

License

Grafana is distributed under AGPL-3.0-only. For Apache-2.0 exceptions, see LICENSING.md.

changelog

7.3.0-beta1 (2020-10-15)

Features / Enhancements

7.2.0 (2020-09-23)

Features / Enhancements

7.1.0-beta1 (2020-07-01)

Features / Enhancements

7.0.4 (2020-06-25)

Features / Enhancements

7.0.0 (2020-05-18)

Bug Fixes

  • Explore: Fixes loading more logs in logs context view. #24135, @Estrax

7.0.0-beta3 (2020-05-08)

Features / Enhancements

  • Forms: Remove Forms namespace [BREAKING]. Will cause all Forms imports to stop working. See migration guide below. #24378, @tskarhed

7.0.0-beta.2 (2020-05-07)

Bug Fixes

  • Dashboard: Fix for folder picker menu not being visible outside modal when saving dashboard. #24296, @tskarhed
  • Select: Fixes so component loses focus on selecting value or pressing outside of input. #24008, @mckn

7.0.0-beta.1 (2020-04-28)

Breaking changes

@grafana/ui forms migration notice

In Grafana 7 we have migrated from our old form components to LegacyForms namespace. The new components were previously available under the Forms namespace.

All the following components were moved to the LegacyForms namespace, and some replaced with the new form components:

  • SecretFormField
  • FormField
  • Select
  • AsyncSelect
  • IndicatorsContainer
  • NoOptionsMessage
  • ButtonSelect
  • Input
  • Switch

One exception to this is FormLabel, which has been renamed to InlineFormLabel.

If you were previously using the legacy form styles and your plugin is breaking, change from this:

import { Switch } from '@grafana/ui';
…
<Switch .../>

To this:

import { LegacyForms } from '@grafana/ui';
…
<LegacyForms.Switch ... />

If you were previously using the new form styles under the Forms namespace, change from this:

import { Forms } from '@grafana/ui';
…
<Forms.Switch ... />

To this:

import { Switch} from '@grafana/ui';
…
<Switch ... />

To see the new form components visit our Storybook

Create custom value with Select

Previously the only thing you had to do to enable creating a custom value with Select was to add the allowCustomValue prop. Now you also have to add a onCreateOption handler.

Before:

import { Select } from '@grafana/ui';
...
<Select
...
allowCustomValue
/>

After:

import { Select } from '@grafana/ui';
...
<Select
...
allowCustomValue
onCreateOption={(customValue) => {
    // Do things with the customValue
}}
/>

Features / Enhancements

Bug Fixes

6.6.0-beta.1.0 (2020-01-20)

Features / Enhancements

Bug Fixes

  • API: Optionally list expired API keys. #20468, @papagian
  • grafana/ui: Do not build grafana/ui in strict mode as it depends on non-strict libs. #21319, @dprokop

6.0.0-alpha.0 (2019-02-22)

Version update to 6.0.0 to keep @grafana/ui version in sync with Grafana

1.0.0-alpha.0 (2019-02-21)

First public release