mirror of
https://github.com/grafana/grafana.git
synced 2025-09-26 21:44:30 +08:00
45 lines
2.4 KiB
Plaintext
45 lines
2.4 KiB
Plaintext
import { Meta } from '@storybook/blocks';
|
|
|
|
<Meta title="Docs Overview/Intro" parameters={{ options: { isToolshown: false }, id: 1 }} />
|
|
|
|
# Grafana React Components
|
|
|
|
With @grafana/ui, we want to democratize development. This library of reusable [Grafana](https://github.com/grafana/grafana) components and guidelines is part of the [Saga Design System](https://grafana.com/developers/saga/about/overview) and should help you with contribution and plugin development.
|
|
|
|
## Our vision
|
|
|
|
Grafana Labs started @grafana/ui to make contributing to Grafana as easy as possible for Grafanistas and community members of all fields. We want to create a component library that results in:
|
|
|
|
- Understanding of how each component works and how you can use it to create a great user experience.
|
|
- Short development times and consistent code quality.
|
|
- A beautiful, visually consistent Grafana experience.
|
|
- Transparency about how we work and what we do.
|
|
|
|
### How to get involved
|
|
|
|
When we notice that we need to change something, we determine together what the change should be, then we put the change in place and communicate it publicly. Developers and designers create and improve @grafana/ui together. Throughout the process, we strive to involve you and meet your needs. We are looking forward to discussing your design and improvement ideas, find out how you can help in the [Contribution Guidelines](https://grafana.com/developers/saga/contributing).
|
|
|
|
## Get started
|
|
|
|
- **Explore UI components**
|
|
Click on any of the components in the sidebar to see how they look, and how to configure them. Each component contains documentation of its properties, as well as code examples for how to use it.
|
|
- **Try them out**
|
|
- Experiment with different properties, by clicking on each component story.
|
|
- Change the properties under **Controls** in the side panel.
|
|
- **Use them**
|
|
Once you've found the right component for your use case, click the **Code** tab to see the code implementation, or look at examples under **Docs**.
|
|
|
|
For more details, refer to the [package source](https://github.com/grafana/grafana/tree/main/packages/grafana-ui).
|
|
|
|
## Installation
|
|
|
|
`yarn add @grafana/ui`
|
|
|
|
`npm install @grafana/ui`
|
|
|
|
## Related links
|
|
|
|
- [Build a panel plugin tutorial](https://grafana.com/developers/plugin-tools/tutorials/build-a-panel-plugin)
|
|
- [Plugin developer guide](https://grafana.com/developers/plugin-tools/)
|
|
- [Grafana Tutorials](https://grafana.com/tutorials/)
|