# 插件配置手册

# 基本配置

# name（必须）

插件的名称

类型：String

{
  "name": "my-plugin"
}

1
2
3

# version（必须）

插件版本号，格式要符合 SemVer (opens new window) 规范。

{
  "version": "0.1.0"
}

1
2
3

类型：String

# logo（必须）

插件的图标，值为plugin.json的相对文件路径地址。

类型：String

{
  "logo": "logo.png"
}

1
2
3

# desc（必须）

插件的描述

类型：String

{
  "desc": "插件的描述"
}

1
2
3

# main（必须）

插件的入口文件，值为plugin.json的相对文件路径地址。

类型：String

{
  "main": "index.html"
}

1
2
3

# dev

插件的开发模式配置，值为对象。拥有main与preload属性，表示在开发模式下插件入口文件的地址。

类型：PluginDevConfig

{
  "dev": {
    "main": "http://localhost:9527",
    "preload": "preload.js"
  }
}

1
2
3
4
5
6

# preload

插件的预加载文件，允许开发者在插件页面渲染前执行某些逻辑。值为plugin.json的相对文件路径地址。

类型：String

{
  "preload": "preload.js"
}

1
2
3

# 外观配置

# useScrollbarCSS

是否使用滚动条默认样式

类型：Boolean
默认值：true

{
  "useScrollbarCSS": true
}

1
2
3

# header.title

是否不展示默认标题（默认标题为插件名）

类型：Boolean
默认值：true

{
  "header": {
    "title": true
  }
}

1
2
3
4
5

# header.show

是否展示头部栏

配置为false后，插件将没有头部栏。但你可以通过iHelper.close()等方法来触发头部按钮动作。

类型：Boolean
默认值：true

{
  "header": {
    "show": true
  }
}

1
2
3
4
5

# header.btns

头部栏按钮配置，允许自定义显示的按钮。

可选值为：['pin', 'resize', 'close']

类型：Array<String>
默认值：['pin', 'resize', 'close']

//  只展示关闭按钮
{
  "header": {
    "btns": ["close"]
  }
}

1
2
3
4
5
6

# winOptions

窗体大小配置

{
  "winOptions": {
    "width": 350,
    "height": 450,
    "minWidth": 300,
    "minHeight": 400,
    "maxWidth": 900,
    "maxHeight": 1200
  }
}

1
2
3
4
5
6
7
8
9
10

类型：PluginWinOptions

# 权限配置

控制插件的某些可使用的权限，值为对象

类型：PluginPermissions

# permissions.clipboard

是否启用监听剪贴板变化功能

类型：Boolean

{
  "permissions": {
    "clipboard": true
  }
}

1
2
3
4
5

← 编写新的插件