Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.3/packages_api/ui.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.3/packages_api/ui/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
@grafana/ui package
A library containing the different design components of the Grafana ecosystem.
Classes
| Class | Description |
|---|---|
| BarGauge | |
| BigValue | |
| Cascader | |
| ClickOutsideWrapper | |
| ClipboardButton | |
| ErrorBoundary | |
| ErrorBoundaryAlert | |
| Gauge | |
| Graph | |
| GraphNG | “Time as X” core component, expects ascending x |
| GraphSeriesToggler | |
| JsonExplorer | JsonExplorerJsonExplorer allows you to render JSON objects in HTML with a **collapsible** navigation. |
| JSONFormatter | |
| List | |
| LogMessageAnsi | |
| ModalsProvider | |
| Popover | |
| PopoverController | |
| QueryField | Renders an editor field. Pass initial value as initialQuery and listen to changes in props.onValueChanged. This component can only process strings. Internally it uses Slate Value. Implement props.onTypeahead to use suggestions, see PromQueryField.tsx as an example. |
| RefreshPicker | |
| SelectValueEditor | |
| SetInterval | |
| StatsPicker | |
| StringArrayEditor | |
| UnitPicker | |
| UPlotConfigBuilder | |
| VizRepeater |
Enumerations
| Enumeration | Description |
|---|---|
| BarGaugeDisplayMode | |
| BigValueColorMode | |
| BigValueGraphMode | |
| BigValueJustifyMode | |
| BigValueTextMode | Options for how the value & title are to be displayed |
| CompletionItemKind | |
| EventsWithValidation | |
| LegacyInputStatus | |
| NodeGraphDataFrameFieldNames | |
| SeriesVisibilityChangeBehavior |
Functions
Interfaces
Namespaces
| Namespace | Description |
|---|---|
| commonOptionsBuilder | |
| DOMUtil | |
| Modal | |
| RadioButtonGroup | |
| ReactUtils | |
| styleMixins | |
| VizLegend |