我的书签
添加书签
移除书签PluginConfig参数
开发者开发插件时可以设定的参数
name
- 类型：
string - 含义：插件名称
level
- 类型：
number - 默认：0
- 含义：插件的层级，数值越高层级越高。
- 注意事项
- 该值会被用户设置的 level 值所覆盖
- 该值可以在插件内部使用
$level动态更改。
opearable
- 类型：
boolean - 默认：
true - 含义：该插件是否为可操作插件，若为
true，则可正常操作，若为false，则为透明插件。 - 注意事项
- 该值会被用户设置的 operable 值所覆盖。
- 可通过
$operable动态更改
penetrate
- 类型：
boolean - 默认：
false - 含义：该插件是否为穿透插件
- 注意事项：
- 该值一经设定无法更改。
- 可通过
$penetrate获取
inner
- 类型：
boolean - 默认：
true - 含义：是否为内层插件
- 注意事项：
- 该值一经设定无法更改
- 可通过
$inner获取
autoFocus
- 类型：
boolean | undefined - 默认：
undefined - 含义：点击该插件时是否会自动聚焦到 video 上。
- 注意事项：
- 当该值为
undefined时，内层插件会自动聚焦，外层插件不会 - 该值一经设定无法更改
- 可通过
$autoFocus获取
- 当该值为
el
- 类型：
string | HTMLElement | undefined - 默认：
undefined - 含义：该插件所申请的 dom 节点
- 注意事项
- 若该值为
undefined，则 Chimee 会生成一个 div 容器用于放置插件。 - 若该值为字符串，则 Chimee 会以将字符串合法化并生成一个自定义元素。
- 若该值为
HTMLElement节点，则 Chimee 会将该节点移至合适位置。 - 可通过
$dom动态获取该元素
- 若该值为
className
- 类型：
string | Array<string> | undefined - 默认：
undefined - 含义：该插件 dom 节点的 class 初始值
- 注意事项
- 可传入字符串组成的数组
- 可传入一个字符串，多个类以空格分开
beforeCreate
- 类型：
Function | undefined - 默认：
undefined - 含义：beforeCreate 的生命周期钩子
- 注意事项：
- 该函数是同步执行的
- 该函数会获得部分插件配置
- events
- data
- computed
- methods
- 该插件会获得用户配置
create
- 类型：
Function | undefined - 默认：
undefined - 含义：create 的生命周期钩子
- 注意事项：
- 该函数是同步执行的
init
- 类型：
Function | undefined - 默认：
undefined - 含义：init 的生命周期钩子
- 注意事项
- 该函数会获得 videoConfig （视频初始化参数）
- 该函数不一定会被触发
- 若该插件是在播放器生成后再进行安装，则不会执行此函数。
- 该函数是同步执行的
inited
- 类型：
Function | undefined - 默认：
undefined - 含义：inited 的生命周期钩子
- 注意事项
- 该函数可异步执行
- 若该函数不返回 Promise, 则视作插件安装完毕。
ready变更为resolved状态，readySync变更为true。 - 若该函数返回 Promise，则
ready值即为该 Promise。
destroy
- 类型：
Function | undefined - 默认：
undefined - 含义：destroy 的声明钩子
events
- 类型：
{[string]: Function} - 默认：
undefined - 含义：批量绑定事件的语法糖。
- 注意事项：
- 该参数可在 beforeCreate 的钩子中获得并更改
data
- 类型：
Object - 默认：
undefined - 含义：将以上参数动态绑定到示例中的语法糖
computed
- 类型：
{[string]: Function | {get?: Function, set?: Function}} - 默认：
undefined - 含义：将以上方法以 getter / setter 的模式绑定
methods
- 类型：
{[string]: Function} - 默认：
undefined - 含义：将以上函数绑定到实例上的语法糖
- 注意事项：
- 以上函数一经绑定将会永远锁定该插件实例，无法更改
