# @grafana/plugin-ui 中文文档

规范地址：https://npmcn.com/package/%40grafana/plugin-ui/

版本：0\.18\.0
npm 元数据更新时间：2026-11-11T09:07:38.669Z
中文译文更新时间：2026-11-16T21:45:53.658Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40grafana/plugin-ui
原文对照：https://npmcn.com/package/%40grafana/plugin-ui/?lang=original
项目主页：https://github.com/grafana/plugin-ui#readme
源码仓库：https://github.com/grafana/plugin-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9.3 MB，514 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：17 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，@grafana/ui ^13\.0\.0，@grafana/data ^13\.0\.0，monaco-editor \>=0\.30，@grafana/runtime ^13\.0\.0，@grafana/e2e-selectors ^13\.0\.0，@testing-library/react ^16\.3\.2，@testing-library/jest-dom ^7\.0\.0，@testing-library/user-event ^14\.6\.1
- 首次发布：2022-10-17T15:29:03.030Z
- 最新版本发布：2026-11-11T09:07:38.215Z
- 近 30 天下载量：240517（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 34 个）

## 中文简介

Grafana 插件的反应组件

## 安装

```sh
npm install @grafana/plugin-ui
```

也可以使用：`pnpm add @grafana/plugin-ui`、`yarn add @grafana/plugin-ui`、`bun add @grafana/plugin-ui`

## README

# 插件用户

Grafana 插件的反应组件

## 发展

需要从源头运行 Grafana 的本地版本 .

### 设置本地版本的 @ grafana/ plugin- ui , 并附带应用插件

1.  运行 `yarn install && yarn dev`
2.  运行 `yarn link ../path/to/plugin-ui` 从应用程序插件目录。 务必不要对Grafana/grafana进行引入包的修改. json.
3.  启动应用程序插件开发服务器 .

要避免在开发过程中 手动重建核心地盘 而不是运行 `yarn dev`运行

```bash
yarn tsc -p ./tsconfig.build.json && yarn rollup -c rollup.config.ts --configPlugin esbuild -w --watch.onEnd="cd ../grafana/public/app/plugins/datasource/loki && yarn build
```

替换 -- watch.on 以你的目标完成指挥.

有更好的方法做到这一点, 当你找到它, 请在这里添加它, 所以它不是那么痛苦的工作 与这个雷波.

## 抚养结构

### 为什么 `react` 财务报告和审定财务报表 `react-dom` 必须留在里面 `peerDependencies`

`react` 财务报告和审定财务报表 `react-dom` **必须** 被宣布为 `peerDependencies` 永远不能只出现在 `devDependencies`。 。 。 .

此软件包是使用 Rollup 构建的 `rollup-plugin-node-externals({ deps: true, peerDeps: true })`。 。 。 . 该插件将列出的软件包外部化 `dependencies` 财务报告和审定财务报表 `peerDependencies` - 任何其它东西 装入出错输出中.

反应不是由这个包直接导入的,而是通过捆绑的中转解决 依赖关系( e)`react-use`, (中文(简体) ), `react-calendar`, (中文(简体) ), `react-popper-tooltip`(见A/C.5/49/70,附件)。 因为卷起决心 CJS 软件包通过 `@rollup/plugin-commonjs`,任何没有标记的中转解反应 外部结尾为 `dist/esm/node_modules/react/` 在出版的捆绑.

当一个 Grafana 插件消费此软件包时, 其网页包的构建会遵循这些相对路径的导入 (单位:千美元)`_virtual/index.js → node_modules/react/index.js`)和生产 **2 反应实例** 输入 最后捆绑 :

1.  Grafana 的主机 React —— 加载为 AMD 外部 `react-dom`
2.  此软件包的内含副本

React的钩子调度器是React上的一个单通. `react-dom` 违反第1个案例, 但来自此包组件的钩子使用实例 2 的调度器,即 `null` 时间 运行时间。 每通钩子呼叫`useState`, (中文(简体) ), `useEffect`,.)抛出:

```
Cannot read properties of null (reading 'useState')
```

保存中 `react` 财务报告和审定财务报表 `react-dom` 内 `peerDependencies` 是因为什么原因 `rollup-plugin-node-externals` 将它们外部化,产生一个没有内在反射的干净分光.

## 部署

在软件包中增加版本。 json 并确保 [变动情况](https://npmcn.com/package/%40grafana/plugin-ui/CHANGELOG.md) 包括每个合并的 PR 的信息 。 这个 `publish-npm` 工作流程会触发版本的更改,该版本会在npm发布发布.

## Grafana 兼容性

`@grafana/plugin-ui@0.13.2` 与Grafana版本的10.4.7和更高版本兼容。 如果 `grafanaDependency` 字段中的插件.json文件设置为更早的版本,您应该将其修改为 `>=10.4.7` 在这样做时,也考虑加增您插件的主要版本,以确保Grafana < 10.4.7上的用户不会意外地安装不相容的插件版本.

## 故事书

故事书很破碎,组件链接到只存在于Grafana内部的资产,因为大多数的组件都没有为故事书添加支持.

```bash
yarn storybook
```

## 常见问题

### @grafana/plugin-ui 是什么？

Grafana 插件的反应组件

### 如何安装 @grafana/plugin-ui？

在项目目录运行 npm install @grafana/plugin-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）、@grafana/ui（^13\.0\.0）、@grafana/data（^13\.0\.0）、@grafana/runtime（^13\.0\.0）、@grafana/e2e-selectors（^13\.0\.0）、@testing-library/react（^16\.3\.2）、@testing-library/jest-dom（^7\.0\.0）、@testing-library/user-event（^14\.6\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @grafana/plugin-ui 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @grafana/plugin-ui 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @grafana/plugin-ui 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @grafana/plugin-ui 可以商用吗？

@grafana/plugin-ui 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @grafana/plugin-ui 的下载量有多少？

根据 npm 官方下载统计，@grafana/plugin-ui 在 2026/10/17 – 2026/11/15 这 30 天内被下载 240,517 次，日均约 8,017 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @grafana/plugin-ui 还在维护吗？

最新版本 0\.18\.0 发布于 2026/11/11（5 天前）；至今共发布 82 个版本，其中过去 12 个月发布了 34 个；首次发布于 2022/10/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

