插件操作

在 chimee 中我们会使用插件来实现业务需求，因此我们要进行插件安装。在 chimee 上有以下几个方法。

install

• 类型：Function
• 静态方法
• 含义：安装一个插件
• 参数：
  • config
    • 类型：PluginConfig |Function
    • 详细可查看如何写插件
      要使用一个插件，我们首先得利用该方法安装插件，要注意该方法是一个静态方法。

import popup from 'chimee-plugin-popup';
import Chimee from 'chimee'
Chimee.install(popup({
  name: 'ccPopup',
  title: '这是一个居中信息框',
  body: '这里是信息内容',
  offset: '50% 50%',
  width: '200px'
}));

hasInstalled

• 类型：Function
• 静态方法
• 含义：检测一个插件是否已安装
• 参数：
  • name
    • 类型：string
    • 含义：插件名称
• 返回值
  • 类型： boolean

import popup from 'chimee-plugin-popup';
import Chimee from 'chimee'
Chimee.install(popup({
  name: 'ccPopup',
  title: '这是一个居中信息框',
  body: '这里是信息内容',
  offset: '50% 50%',
  width: '200px'
}));
Chimee.hasInstalled(popup.name); // true
Chimee.hasInstalled('something else'); // false

uninstall

• 类型：Function
• 静态方法
• 含义：卸载插件
• 参数：
  • name
    • 类型：string
    • 含义：插件名称

卸载插件后，正在使用该插件的实例不受影响。卸载后新建的实例无法使用此插件。

getPluginConfig

• 类型：Function
• 静态方法
• 含义：获取插件配置
• 参数：
  • name
    • 类型：string
    • 含义：插件名称
• 返回值
  • 类型：PluginConfig | void |Function

use

• 类型：Function
• 含义：使用插件
• 参数：
  • option
    • 类型：string | Object
    • 含义：插件名称或插件选项
      该函数其实就是新建实例时传入的 plugin选项所使用的方法。利用此函数可以动态安装插件。

import popup from 'chimee-plugin-popup';
import danmu from 'chimee-plugin-danmu';
import Chimee from 'chimee'
Chimee.install(popup({
  name: 'ccPopup',
  title: '这是一个居中信息框',
  body: '这里是信息内容',
  offset: '50% 50%',
  width: '200px'
}));
Chimee.install(danmu)
const chimee = new Chimee('#wrapper');
chimee.use(popup.name);
chimee.use({
  name: danmu.name,
  theme: 'white'
});

unuse

• 类型：Function
• 含义：停用插件
• 参数：
  • name
    • 类型：string
    • 含义：插件名称