# Plug-in configuration manual

# basic configuration

# name (required)

The name of the plugin

Type: String

{
  "name": "my-plugin"
}

1
2
3

# version (required)

The plug-in version number, the format must conform to the SemVer (opens new window) specification.

{
  "version": "0.1.0"
}

1
2
3

Type: String

# logo (required)

The icon of the plug-in, the value is the relative file path address of plugin.json.

Type: String

{
  "logo": "logo.png"
}

1
2
3

# desc (required)

Description of the plug-in

Type: String

{
  "desc": "Description of the plug-in"
}

1
2
3

# main (required)

The entry file of the plugin, the value is the relative file path address of plugin.json.

Type: String

{
  "main": "index.html"
}

1
2
3

# dev

The development mode configuration of the plug-in, the value is the object. It has the attributes of main and preload, indicating the address of the plug-in entry file in development mode.

Type: PluginDevConfig

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

1
2
3
4
5
6

# preload

The preloaded file of the plug-in allows the developer to execute certain logic before the plug-in page is rendered. The value is the relative file path address of plugin.json.

Type: String

{
  "preload": "preload.js"
}

1
2
3

# Appearance configuration

# useScrollbarCSS

Whether to use the default style of the scroll bar

Type: Boolean
Default value: true

{
  "useScrollbarCSS": true
}

1
2
3

# header.title

Whether to not display the default title (the default title is the plug-in name)

Type: Boolean
Default value: true

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

1
2
3
4
5

# header.show

Whether to display the header bar

After the configuration is false, the plug-in will not have a header bar. But you can trigger head button actions through methods such as iHelper.close().

Type: Boolean
Default value: true

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

1
2
3
4
5

# header.btns

The header bar button configuration allows customizing the displayed buttons.

Optional values: ['pin','resize','close']

Type: Array<String>
Default value: ['pin','resize','close']

// Only show the close button
{
  "header": {
    "btns": ["close"]
  }
}

1
2
3
4
5
6

# winOptions

Window size configuration

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

1
2
3
4
5
6
7
8
9
10

Type: PluginWinOptions

# Rights Profile

Control some of the available permissions of the plug-in, the value is the object

Type: PluginPermissions

# permissions.clipboard

Whether to enable monitoring clipboard changes

Type: Boolean

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

1
2
3
4
5

← Write a new plug-in