跳到主要内容

侧边栏菜单

适用环境SaaS
私有部署

要求​

ONES@ones/cli-ability-template@ones/cli-plugin
v3.11.25+v1.4.0+v1.5.1+

概述​

当你想在 ONES 中嵌入一个比较独立的业务功能，不会和 ONES 已有的页面有交互。或者你想要的插件业务需要频繁的配置调整，需要有一个便捷的入口时。你都可以使用这个 侧边栏菜单 能力。它有非常便捷的入口，形式上它很像 ONES 的一个应用，所以可以用这个能力来处理你独立的业务。

使用侧边栏菜单能力的插件不仅仅支持在团队下安装，同时也支持在组织管理下安装。但是在不同场景下安装时，请先保证你创建的是对应场景类型的插件。

使用​

第一步：添加能力​

  1. 选择能力。

    在插件工程根目录下执行 npx op add ability 指令，并选择：sidebar-menu@1.0.0。

  2. 根据提示, 填写关联插槽 ones:app:new 名称，并创建子模块。

    警告

    该插槽支持一级子模块，所以你必须添加第一级的子模块，否则将会表现不正常。

  3. 前两步执行完成后，会自动更新 plugin.yaml 配置，并生成模块模版文件。

    • 自动在 abilities 属性下新增一段配置。配置如下：

      config/plugin.yaml
      abilities:
        - id: 8k5frAw6
          name: 左侧菜单栏
          version: 1.0.0
          abilityType: SidebarMenu
          relateModule:
            systemMenu: 'ones-app-new-aBFM'

    • 自动在 modules 属性下新增一段配置，配置如下：

    config/plugin.yaml
    modules:
      - id: ones-app-new-aBFM
        title: 新增侧边栏
        moduleType: ones:app:new
        modules:
          - id: ones-app-new-JusW
            title: 顶栏
            entry: modules/ones-app-new-aBFM/ones-app-new-JusW/index.html
    • 自动在 /web/src/modules 目录下新增如下模版：

    你可以在此处编写你的插件逻辑。该插槽具体支持配置项请参考：ones:app:new。

第二步：在 ONES 中使用​

完成你的插件编写之后，将插件打包并安装到 ONES 中，这样你就可以看到这个能力的表现了。点击启用，启用成功之后刷新页面。你会看到如下图所示：左侧菜单栏新增了该插件的入口，并且详情页也有打开按钮，可以直接打开插件页面。

提示

如果你新建的是一个组织级别插件，那么在插件详情页面将不会有打开这个按钮。

第三步：控制入口的显示和隐藏​

我们在 ONES 内置了一些控制该入口的一些能力，首先你需要进入【配置中心】-【系统偏好设置】-【侧边栏菜单】。你可以在这个页面对插件入口的显示名称、显示顺序、是否显示等。

第四步：设置​

提示

如果你替换了整个右侧区域，包括顶部区域，那么是没有设置按钮的。

在支持该能力的同时，我们也支持了这个能力的权限配置，所以你可以对新增的每一个模块做单独的权限点配置。为了方便你做权限的配置我们在顶栏给你提供了设置按钮，可以直接跳转到对应插件详情页面。

FAQ​

如果我想要创建多个"侧边栏菜单"怎么办？​

我们规定一个插件只能定义一个侧边栏菜单，如果超过这个限制，插件启用会失败并给予错误提示。所以你想定义多个侧边栏菜单那就得安装多个插件。

最后于 更新