layui/docs/component/detail/options.md

3.1 KiB

属性名 描述 类型 默认值
name

组件名称。如 name:'tabs',那么在使用组件时,可通过 layui.tabs 获得该组件。注:组件名必须唯一

string -
config

定义组件渲染时的默认配置项。

object -
CONST

通用常量集,一般存放固定字符,如类名等。如:

CONST: {
  ELEM: 'layui-tabs',
}

上述常量可通过 component.CONST.ELEM 获得。

object -
isRenderWithoutElem

渲染是否无需指定目标元素。即无需设置 elem 选项,一般用于渲染即显示的组件类型。

boolean

false

isRenderOnEvent

渲染是否仅由事件触发。如 dropdown 这类通过点击触发的组件,那么应该设置为 true;而诸如 tabs 这类初始即展示的组件,则应该设置为 false推荐根据组件类型始终显式设置对应值

boolean

true

isDeepReload

组件重载时是否允许为深度重载,即每次重载时选项进行深度合并。

boolean

false

render

组件渲染的逻辑。

render: function() {
  // 组件的容器构建、插入等
  // …
}

也可以通过原型 component.Class.prototype.render 进行定义。

beforeInit

组件初始化之前的回调函数。

beforeInit: function(options) {
  console.log(options); // 获得组件初始化前的配置项
}
beforeRender

渲染之前的回调函数。

beforeRender: function(options) {
  console.log(options); // 获得组件渲染前的配置项
}
extendsInstance

扩展组件渲染的实例对象的回调函数。如:

extendsInstance: function(that) {
  return {
    // 关闭组件
    close: function() {
      that.remove(); // 调用组件原型中的 remove 方法
    }
  }
}

那么,当组件渲染时,即可通过它返回的对象调用实例方法:

var inst = xxx.render(); // 某组件渲染
inst.close(); // 关闭某组件
events

定义组件各类内部事件。

events: function() {
  // 亦可包含针对组件的 window, document 等全局事件
  // …
}

也可以通过原型 component.Class.prototype.events 进行定义。