跳至主要内容

将插件从 Grafana 版本 10.0.x 迁移到 10.1.x

按照以下说明将插件从 Grafana 版本 10.0.x 迁移到 10.1.x。

grafana-ui 中 IconButton 组件的可访问性更新​

由于可访问性问题，我们更新了组件的 TypeScript 接口。此更改已通过 PR 69699 传递到核心 grafana 存储库。

如果您在插件中使用 IconButton 组件，您将收到与更改相关的 TypeScript 错误。

建议的操作

  • 审查插件中 IconButton 的用例。
  • 添加一个有意义的工具提示，该组件也将使用它作为 aria-label。
  • 另一种选择是设置 aria-label。在这种情况下，不会显示工具提示。

请注意： IconButton 曾经有一个名为 ariaLabel 的属性，该属性在此更改中已被弃用。现在您可以改为使用常规属性 aria-label。

更新到 React Router v6​

从 Grafana 10 开始，插件可以开始使用 react-router 的 v6 版本。总的来说，react-router v6 旨在简化路由配置并为开发人员提供更灵活、更直观的 API。

如果您的当前插件版本需要与 Grafana v9 保持兼容性，那么您可以在 Grafana v10 中继续使用 react-router@v5。两个版本都可用于插件。但是，我们强烈建议开发人员尽快将其插件更新为使用 v6 版本的 react-router，因为 v5 版本将在 Grafana v11 中被弃用并随后删除。

有关更多一般信息，请参阅 官方 React Router v5 到 v6 迁移指南。

使用 @grafana/create-plugin 更新​

按照以下步骤开始在插件中使用 react-router v6

通过在 <project-root>/.cprc.json 中设置以下功能标志来启用使用 react-router@v6

{
  "features": {
    "useReactRouterV6": true
  }
}

现在使用 create-plugin 工具更新构建配置

npx @grafana/create-plugin@latest update

更新构建配置后，您可能需要对插件进行其他更新。为此，请按照以下步骤操作

2. 使用 <Routes> 代替 <Switch>​

// Using <Routes> instead of <Switch> in `react-router` v6
import { Routes } from 'react-router-dom';

// ...

return (
  <Routes>
    <Route path="/" element={<Home />} />
  </Routes>
);

3. 从 <Route> 组件中删除 exact 属性​

return (
  <Routes>
    {/* BAD (Until v5) */}
    <Route exact path="/" element={<Home />} />

    {/* GOOD (From v6) */}
    {/* (Routes are "exact" by default, you need to use the "*" to match sub-routes) */}
    <Route path="/" element={<Home />} />
  </Routes>
);

4. 按照原始 react-router 迁移指南进行更深入的更改​

访问 官方 react-router v5 到 v6 迁移指南 以获取更多信息。