Skip to content

NocoBase 0.15:全新的插件设置中心

Posted on:2023年11月13日 at 02:36

新特性

Plugin settings manager

不兼容的变化

插件配置页面注册方式

以前使用 SettingsCenterProvider 注册插件配置页面,现在需要通过插件化注册。

当页面仅有一个 Tab 时,新版本的 Tab 会删掉,仅保留页面的标题和图标。

const HelloProvider = React.memo(props => {
  return (
    <SettingsCenterProvider
      settings={{
        hello: {
          title: "Hello",
          icon: "ApiOutlined",
          tabs: {
            tab1: {
              title: "Hello tab",
              component: HelloPluginSettingPage,
            },
          },
        },
      }}
    >
      {props.children}
    </SettingsCenterProvider>
  );
});

现在需要改为:

class HelloPlugin extends Plugin {
  async load() {
    this.app.pluginSettingsManager.add("hello", {
      title: "Hello", // 原 title
      icon: "ApiOutlined", // 原 icon
      Component: HelloPluginSettingPage, // 原 tab component
      aclSnippet: "pm.hello.tab1", // 权限片段,保证权限的 code 和之前的一致,如果是新插件,不需要传这个参数
    });
  }
}

也就是删除了 tab1Hello Tab

其中参数 aclSnippetpm.hello.tab1 对应原来的 settings 对象的 key:

<SettingsCenterProvider
  settings={{
    hello: {
      // 这里的 hello 对应 `pm.hello.tab1` 中的 `hello`
      tabs: {
        tab1: {
          // 这里的 tab1 对应 `pm.hello.tab1` 中的 tab1
        },
      },
    },
  }}
></SettingsCenterProvider>
const HelloProvider = React.memo(props => {
  return (
    <SettingsCenterProvider
      settings={{
        hello: {
          title: "Hello",
          icon: "ApiOutlined",
          tabs: {
            tab1: {
              title: "Hello tab1",
              component: HelloPluginSettingPage1,
            },
            tab2: {
              title: "Hello tab2",
              component: HelloPluginSettingPage2,
            },
          },
        },
      }}
    >
      {props.children}
    </SettingsCenterProvider>
  );
});

现在需要改为:

import { Outlet } from "react-router-dom";

class HelloPlugin extends Plugin {
  async load() {
    this.app.pluginSettingsManager.add("hello", {
      title: "Hello", // 原 title
      icon: "ApiOutlined", // 原 icon
      Component: Outlet,
    });

    this.app.pluginSettingsManager.add("hello.tab1", {
      title: "Hello tab1", // 原 tab1 title
      Component: HelloPluginSettingPage1, // 原 tab1 component
    });

    this.app.pluginSettingsManager.add("hello.tab2", {
      title: "Hello tab2", // 原 tab2 title
      Component: HelloPluginSettingPage1, // 原 tab2 component
    });
  }
}

获取 pluginSettingsManager 对应的路由信息

const baseName = app.pluginSettingsManager.getRouteName("hello");
// admin.settings.hello
const basePath = app.pluginSettingsManager.getRoutePath("hello");
// /admin/settings/hello

如果插件配置页面内部有链接跳转的话,需要进行相应的更改,例如:

navigate("/admin/settings/hello/1");
navigate("/admin/settings/hello/2");

// 可以更改为
const basePath = app.pluginSettingsManager.getRoutePath("hello");
navigate(`${basePath}/1`);
navigate(`${basePath}/2`);

更多信息,请参考 插件配置页面

更新记录

完整的更新记录,请参考 更新记录