mirror of https://github.com/layui/layui
Merge branch 'main' into 2.x
commit
95a0503f41
|
@ -25,7 +25,7 @@ toc: true
|
|||
|
||||
`MOD_NAME.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
<h3 id="options" lay-toc="{level: 2, hot: true}">属性</h3>
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ layui.use(function(){
|
|||
- 在元素外层设置 `class="layui-carousel"` 来定义一个轮播容器
|
||||
- 在元素内层设置属性 `carousel-item` 用来定义条目容器
|
||||
|
||||
<h3 id="demo-config" lay-toc="{level: 2, hot: true}">属性配置预览</h3>
|
||||
<h3 id="demo-config" lay-toc="{level: 2, hot: true}">可选项预览</h3>
|
||||
|
||||
<pre class="layui-code" lay-options="{preview: true, codeStyle: 'height: 515px;', layout: ['preview', 'code'], tools: ['full'], done: function(obj){
|
||||
obj.render();
|
||||
|
@ -215,4 +215,4 @@ layui.use(function(){
|
|||
});
|
||||
</script>
|
||||
</textarea>
|
||||
</pre>
|
||||
</pre>
|
||||
|
|
|
@ -33,7 +33,7 @@ div[carousel-item]>*:nth-child(2n+1){background-color: #16baaa;}
|
|||
|
||||
`carousel.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法返回一个实例对象,包含操作当前实例的相关方法成员。
|
||||
|
||||
|
@ -46,7 +46,7 @@ console.log(inst); // 得到当前实例对象
|
|||
|
||||
`inst.reload(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
通过渲染返回的实例对象,可获得重载方法,用于实现对实例的属性重载。
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ toc: true
|
|||
|
||||
`var codeInst = layui.code(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)。
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)。
|
||||
|
||||
其中 `codeInst` <sup>2.8.17+</sup> 即实例返回的对象,包含对当前实例进行重载等方法成员,如:
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@ toc: true
|
|||
|
||||
`colorpicker.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 <sup>2.7+</sup> : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
|
|
@ -17,7 +17,7 @@ toc: true
|
|||
|
||||
`layui.component(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法返回一个对象,包含用于组件对外的基础接口,如:组件渲染、重载、事件操作,及构造函数等等。用法示例:
|
||||
|
||||
|
@ -45,7 +45,7 @@ layui.define('component', function(exports) {
|
|||
});
|
||||
```
|
||||
|
||||
<h3 id="options" lay-toc="{level: 2}">属性配置</h3>
|
||||
<h3 id="options" lay-toc="{level: 2}">属性选项</h3>
|
||||
|
||||
<div>
|
||||
{{- d.include("/component/detail/options.md") }}
|
||||
|
@ -78,7 +78,7 @@ layui.define('component', function(exports) {
|
|||
|
||||
| 选项 | 描述 |
|
||||
| --- | --- |
|
||||
| elem | 件渲染指定的目标元素选择器或 DOM 对象 |
|
||||
| elem | 组件渲染指定的目标元素选择器或 DOM 对象 |
|
||||
| id | 组件渲染的唯一实例 ID |
|
||||
| show | 是否初始即渲染组件。通常结合创建组件设定的 `isRenderOnEvent` 选项决定是否启用 |
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@ toc: true
|
|||
|
||||
`dropdown.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 <sup>2.8+</sup> : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
@ -111,7 +111,7 @@ dropdown.render({
|
|||
`dropdown.reload(id, options);`
|
||||
|
||||
- 参数 `id` : 组件渲染时定义的 `id` 属性值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于对下拉菜单进行完整重载,所有属性均可参与到重载中。
|
||||
|
||||
|
@ -177,4 +177,4 @@ dropdown.render({
|
|||
});
|
||||
// 打开对应的组件面板
|
||||
dropdown.open('test');
|
||||
```
|
||||
```
|
||||
|
|
|
@ -24,10 +24,10 @@ toc: true
|
|||
|
||||
`util.fixbar(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
<h2 id="options" lay-toc="{level: 2, hot: true}">属性</h2>
|
||||
|
||||
<div>
|
||||
{{- d.include("/fixbar/detail/options.md") }}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -33,7 +33,7 @@ toc: true
|
|||
|
||||
`flow.load(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
信息流是分页的另一种表现形式,新加载的内容不替换原有的内容,而是随着滚动条滚动而追加显示。[#详见示例](#examples)
|
||||
|
||||
|
@ -47,7 +47,7 @@ toc: true
|
|||
|
||||
`flow.lazyimg(options);`
|
||||
|
||||
- 参数 `options` : 属性配置项。可选项见下表。
|
||||
- 参数 `options` : 属性选项。可选项见下表。
|
||||
|
||||
| 属性名 | 描述 |
|
||||
| --- | --- |
|
||||
|
|
|
@ -448,7 +448,7 @@ form.on('select(test)', function(data){
|
|||
|
||||
`form.set(options);`
|
||||
|
||||
- 参数 `options` : 全局属性配置项。详见下表:
|
||||
- 参数 `options` : 全局属性选项。详见下表:
|
||||
|
||||
| 属性名 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
|
|
@ -42,7 +42,7 @@ toc: true
|
|||
|
||||
`laydate.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 <sup>2.8+</sup> : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
@ -77,7 +77,7 @@ layui.use(function(){
|
|||
`laydate.hint(id, opts);`
|
||||
|
||||
- 参数 `id` : 组件渲染时定义的 `id` 属性值
|
||||
- 参数 `opts` : 该方法支持的属性可选项,详见下表
|
||||
- 参数 `opts` : 该方法支持的属性选项,详见下表
|
||||
|
||||
| opts | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
|
|
@ -56,7 +56,7 @@ toc: true
|
|||
|
||||
`layer.open(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
打开弹层的核心方法,其他不同类型的弹出方法均为该方法的二次封装。
|
||||
|
||||
|
@ -79,7 +79,7 @@ var index = layer.open({
|
|||
`layer.alert(content, options, yes);`
|
||||
|
||||
- 参数 `content` : 弹出内容
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
- 参数 `yes` : 点击确定后的回调函数
|
||||
|
||||
该方法用于弹出 `dialog` 类型信息框(`type: 0`),参数自动向左补位。
|
||||
|
@ -106,7 +106,7 @@ layer.alert('不开启图标', function(index){
|
|||
`layer.confirm(content, options, yes, cancel);`
|
||||
|
||||
- 参数 `content` : 弹出内容
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
- 参数 `yes` : 点击确定后的回调函数
|
||||
- 参数 `cancel` : 点击第二个按钮(默认「取消」)后的回调函数
|
||||
|
||||
|
@ -133,7 +133,7 @@ layer.confirm('确定吗?', function(index){
|
|||
`layer.msg(content, options, end);`
|
||||
|
||||
- 参数 `content` : 弹出内容
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
- 参数 `end` : 提示框关闭后的回调函数
|
||||
|
||||
该方法用于弹出 `dialog` 类型提示框(`type: 0`),默认 `3` 秒后自动关闭。参数自动向左补位。
|
||||
|
@ -162,7 +162,7 @@ layer.msg('提示框', {
|
|||
`layer.load(icon, options);`
|
||||
|
||||
- 参数 `icon` : 加载图标风格,支持 `0-2` 可选值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于弹出 `load` 类型加载层(`type: 3`)。
|
||||
|
||||
|
@ -184,7 +184,7 @@ layer.close(index);
|
|||
|
||||
- 参数 `content` : 弹出内容
|
||||
- 参数 `elem` : 吸附的目标元素选择器或对象
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于弹出 `tips` 类型贴士层(`type: 4`),默认 `3` 秒后自动关闭。
|
||||
|
||||
|
@ -206,7 +206,7 @@ layer.tips('显示在目标元素上方', '#id', {
|
|||
|
||||
`layer.prompt(options, yes);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
- 参数 `options` : 基础属性选项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
|
||||
| 私有属性 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
@ -243,7 +243,7 @@ layer.prompt({
|
|||
|
||||
`layer.photos(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
- 参数 `options` : 基础属性选项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
|
||||
| 私有属性 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
@ -312,7 +312,7 @@ layui.use(function(){
|
|||
|
||||
`layer.tab(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
- 参数 `options` : 基础属性选项。除了支持 [基础属性](#options) 之外,还支持下表私有属性:
|
||||
|
||||
| 私有属性 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
@ -405,7 +405,7 @@ layer.closeLast(['dialog', 'page']); // 关闭最近一次打开的信息框或
|
|||
|
||||
`layer.config(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于全局设置弹层的默认基础属性。
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ toc: true
|
|||
|
||||
`laypage.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
<h2 id="options" lay-toc="{level: 2, hot: true}">属性</h2>
|
||||
|
||||
|
@ -34,4 +34,4 @@ toc: true
|
|||
|
||||
## 小贴士
|
||||
|
||||
laypage 组件只负责分页本身的逻辑,具体的数据请求及对应的视图渲染需要另外去完成。laypage 不仅能应用在一般的异步分页上,还可直接对一段已知数据进行分页展现,如 table 组件的分页就是采用的 laypage。
|
||||
laypage 组件只负责分页本身的逻辑,具体的数据请求及对应的视图渲染需要另外去完成。laypage 不仅能应用在一般的异步分页上,还可直接对一段已知数据进行分页展现,如 table 组件的分页就是采用的 laypage。
|
||||
|
|
|
@ -28,7 +28,7 @@ toc: true
|
|||
`laytpl(str, options).render(data, callback);`
|
||||
|
||||
- 参数 `str` : 模板原始字符
|
||||
- 参数 `options` <sup>2.8+</sup> : 当前模板实例的属性配置项。可选项详见:[#属性配置](#config)
|
||||
- 参数 `options` <sup>2.8+</sup> : 当前模板实例的属性选项。可选项详见:[#属性选项](#config)
|
||||
- 参数 `data` : 模板数据
|
||||
- 参数 `callback` : 模板渲染完毕的回调函数,并返回渲染后的字符
|
||||
|
||||
|
@ -101,11 +101,11 @@ compile.render(data, callback); // 模板渲染
|
|||
> ### 注意
|
||||
> 开发者在使用模板语法时,需确保模板中的 JS 语句不来自于页面用户输入,即必须在页面开发者自身的可控范围内,否则请避免使用该模板引擎。
|
||||
|
||||
<h2 id="config" lay-toc="{level: 2}">属性配置</h2>
|
||||
<h2 id="config" lay-toc="{level: 2}">选项配置</h2>
|
||||
|
||||
`laytpl.config(options);`
|
||||
|
||||
- 参数 `options` : 属性配置项。可选项详见下表
|
||||
- 参数 `options` : 属性选项。可选项详见下表
|
||||
|
||||
| 属性 | 描述 |
|
||||
| --- | --- |
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
title: 面板 panel,card,collapse
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
||||
# 面板
|
||||
|
||||
> 面板是一个包含普通面板(panel)、卡片面板(card)、折叠面板(collapse)的集合
|
||||
|
@ -44,7 +44,7 @@ toc: true
|
|||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</textarea>
|
||||
</pre>
|
||||
|
||||
|
@ -127,7 +127,7 @@ toc: true
|
|||
|
||||
<!-- import layui -->
|
||||
</textarea>
|
||||
</pre>
|
||||
</pre>
|
||||
|
||||
<h3 id="collapse-tree" lay-toc="{level: 2}">折叠面板嵌套</h3>
|
||||
|
||||
|
@ -141,33 +141,33 @@ toc: true
|
|||
<div class="layui-colla-item">
|
||||
<div class="layui-colla-title">文学家</div>
|
||||
<div class="layui-colla-content layui-show">
|
||||
|
||||
|
||||
<div class="layui-collapse" lay-accordion>
|
||||
<div class="layui-colla-item">
|
||||
<div class="layui-colla-title">唐代</div>
|
||||
<div class="layui-colla-content layui-show">
|
||||
|
||||
|
||||
<div class="layui-collapse" lay-accordion>
|
||||
<div class="layui-colla-item">
|
||||
<div class="layui-colla-title">杜甫</div>
|
||||
<div class="layui-colla-content layui-show">
|
||||
一代诗圣
|
||||
唐代著名诗人,与李白齐名
|
||||
</div>
|
||||
</div>
|
||||
<div class="layui-colla-item">
|
||||
<div class="layui-colla-title">李白</div>
|
||||
<div class="layui-colla-content">
|
||||
<p>一代诗仙</p>
|
||||
<p>唐代著名诗人,与杜甫齐名</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="layui-colla-item">
|
||||
<div class="layui-colla-title">王勃</div>
|
||||
<div class="layui-colla-content">
|
||||
<p>千古绝唱《滕王阁序》</p>
|
||||
<p>著有千古名篇《滕王阁序》</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="layui-colla-item">
|
||||
|
@ -227,7 +227,7 @@ toc: true
|
|||
`element.on('collapse(filter)', callback)`
|
||||
|
||||
- 参数 `collapse(filter)` 是一个特定结构。
|
||||
- `collapse` 为折叠面板点击事件固定值;
|
||||
- `collapse` 为折叠面板点击事件固定值;
|
||||
- `filter` 为导航容器属性 `lay-filter` 对应的值。
|
||||
- 参数 `callback` 为事件执行时的回调函数,并返回一个 `object` 类型的参数。
|
||||
|
||||
|
@ -276,7 +276,7 @@ layui.use(function(){
|
|||
console.log(data.show); // 得到当前面板的展开状态,true or false
|
||||
console.log(data.title); // 得到当前点击面板的标题区域对象
|
||||
console.log(data.content); // 得到当前点击面板的内容区域对象
|
||||
|
||||
|
||||
// 显示状态,仅用于演示
|
||||
layer.msg('展开状态:'+ data.show);
|
||||
});
|
||||
|
|
|
@ -26,7 +26,7 @@ toc: true
|
|||
|
||||
`rate.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 <sup>2.8+</sup> : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
@ -54,4 +54,4 @@ layui.use(function(){
|
|||
|
||||
<div>
|
||||
{{- d.include("/rate/detail/options.md") }}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -24,13 +24,13 @@ toc: true
|
|||
| var slider = layui.slider | 获得 `slider` 模块。 |
|
||||
| [var inst = slider.render(options)](#render) | slider 组件渲染,核心方法。 |
|
||||
| [inst.setValue(value)](#setValue) | 设置滑块值 |
|
||||
| inst.config | 获得当前实例的属性配置项 |
|
||||
| inst.config | 获得当前实例的属性选项 |
|
||||
|
||||
<h2 id="render" lay-toc="{level: 2}">渲染</h2>
|
||||
|
||||
`slider.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 <sup>2.8+</sup> : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
@ -90,4 +90,4 @@ ins1.setValue(60, 1) // 设置结尾值
|
|||
|
||||
<div>
|
||||
{{- d.include("/slider/detail/options.md") }}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -185,7 +185,7 @@ layui.use(function(){
|
|||
`element.tabAdd(filter, options);`
|
||||
|
||||
- 参数 `filter` : tab 容器(`class="layui-tab"`)的 `lay-filter` 属性值
|
||||
- 参数 `options` : 添加 tab 时的属性可选项,见下表:
|
||||
- 参数 `options` : 添加 tab 时的属性选项,见下表:
|
||||
|
||||
| options | 描述 | 类型 | 默认 |
|
||||
| --- | --- | --- | --- |
|
||||
|
@ -225,7 +225,7 @@ layui.use(function(){
|
|||
|
||||
`element.tab(options);`
|
||||
|
||||
- 参数 `options` : 属性可选项,见下表:
|
||||
- 参数 `options` : 属性选项,见下表:
|
||||
|
||||
| options | 描述 | 类型 |
|
||||
| --- | --- | --- |
|
||||
|
|
|
@ -155,7 +155,7 @@ table.render({
|
|||
| LAY_DISABLED | 当前行是否禁止选择 | 可读可写 |
|
||||
| LAY_INDEX | 当前行下标。每页重新从零开始计算 | 只读 |
|
||||
| LAY_NUM | 当前行序号 | 只读 |
|
||||
| LAY_COL | 当前列的表头属性配置项 | 只读 |
|
||||
| LAY_COL | 当前列的表头属性选项 | 只读 |
|
||||
|
||||
示例一: 在返回的数据中设置特定字段:
|
||||
|
||||
|
|
|
@ -527,7 +527,7 @@ initSort: {
|
|||
```
|
||||
table.render({
|
||||
before: function(options){
|
||||
console.log(options); // 当前实例属性配置项
|
||||
console.log(options); // 当前实例属性选项
|
||||
options.where.abc = 123; // 修改或额外追加 where 属性
|
||||
},
|
||||
// … // 其它属性
|
||||
|
|
|
@ -277,7 +277,7 @@ layui.use(['table', 'dropdown'], function(){
|
|||
console.log(obj);
|
||||
if(event === 'email-tips'){
|
||||
layer.alert(layui.util.escape(JSON.stringify(obj.col)), {
|
||||
title: '当前列属性配置项'
|
||||
title: '当前列属性选项'
|
||||
});
|
||||
}
|
||||
});
|
||||
|
|
|
@ -29,7 +29,7 @@ layui.use(['table', 'dropdown', 'util'], function(){
|
|||
var dataCache = obj.dataCache; // 得到当前行缓存数据,包含特定字段 --- 2.8.8+
|
||||
var index = obj.index; // 得到当前行索引
|
||||
var tr = obj.tr; // 得到当前行 <tr> 元素的 jQuery 对象
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
var e = obj.e; // 当前的 jQuery 事件对象 --- 2.9.14+
|
||||
console.log('rowContextmenu', obj); // 查看返回对象的所有成员
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ toc: true
|
|||
|
||||
<h3 id="set" class="ws-anchor ws-bold">全局设置</h3>
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法主要用于初始化设置属性默认值。实际应用时,必须先设置该方法,再执行渲染、重载等操作。
|
||||
|
||||
|
@ -74,7 +74,7 @@ table 提供了以下三种渲染模式,在实际使用时,一般按情况
|
|||
|
||||
`table.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法返回当前实例对象,包含可操作当前表格的一些成员方法。
|
||||
|
||||
|
@ -119,7 +119,7 @@ layui.use(function(){
|
|||
</table>
|
||||
```
|
||||
|
||||
> 2.8 之前版本通过 `lay-data="{}"` 定义属性配置项;<br>
|
||||
> 2.8 之前版本通过 `lay-data="{}"` 定义属性选项;<br>
|
||||
> 2.8+ 版本推荐采用 `lay-options`,但同时兼容 `lay-data`。
|
||||
|
||||
|
||||
|
@ -128,7 +128,7 @@ layui.use(function(){
|
|||
`table.init(filter, options);`
|
||||
|
||||
- 参数 `filter` : `<table>` 元素对应的 `lay-filter` 属性值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于将已输出在页面中的静态表格内容转换为动态 table 组件。[#参考相关示例](#demo-init)
|
||||
|
||||
|
@ -220,7 +220,7 @@ table 的属性众多,我们大致分为以下几种:
|
|||
`table.reload(id, options, deep);`
|
||||
|
||||
- 参数 `id` : table 渲染时的 `id` 属性值
|
||||
- 参数 `options` : 为基础属性配置项
|
||||
- 参数 `options` : 为基础属性选项
|
||||
- 参数 `deep` <sup>2.6+</sup> : 是否采用深度重载(即重载时始终携带初始时及上一次重载时的参数),默认 false。<div style="margin-top:5px;"><button type="button" class="layui-btn layui-btn-sm layui-btn-primary" lay-layer="{content: '#DOCS-table-reload-comp'}">2.6 之前版本的 <code>table.reload()</code> 方法兼容性说明</button></div>
|
||||
|
||||
<div style="display: none;" id="DOCS-table-reload-comp">
|
||||
|
@ -482,7 +482,7 @@ table.resize('test');
|
|||
`table.exportFile(id, data, opts);`
|
||||
- 参数 `id` : table 渲染时的 `id` **或** 要导出的数据表头(当 `id` 为 `array` 类型时)。
|
||||
- 参数 `data` : 要导出的自定义数据,参数可选。
|
||||
- 参数 `opts` <sup>2.7+</sup>: 导出数据时的属性可选项,支持: `type,title`。
|
||||
- 参数 `opts` <sup>2.7+</sup>: 导出数据时的属性选项,支持: `type,title`。
|
||||
|
||||
该方法用于外部导出对应 table 的数据和任意自定义数据。
|
||||
|
||||
|
@ -513,7 +513,7 @@ table.exportFile(['名字','性别','年龄'], [
|
|||
`table.getOptions(id);`
|
||||
- 参数 `id` : table 渲染时的 `id` 属性值
|
||||
|
||||
该方法用于外部获取对应 table 实例的属性配置项。
|
||||
该方法用于外部获取对应 table 实例的属性选项。
|
||||
|
||||
```
|
||||
// 渲染
|
||||
|
@ -622,7 +622,7 @@ layui.use(function(){
|
|||
|
||||
// 头部工具栏事件
|
||||
table.on('toolbar(test)', function(obj){
|
||||
var options = obj.config; // 获取当前表格属性配置项
|
||||
var options = obj.config; // 获取当前表格属性选项
|
||||
var checkStatus = table.checkStatus(options.id); // 获取选中行相关数据
|
||||
console.log(obj); // 查看对象所有成员
|
||||
|
||||
|
@ -697,8 +697,8 @@ table.render({
|
|||
|
||||
// 表头自定义元素工具事件
|
||||
table.on('colTool(test)', function(obj){
|
||||
var col = obj.col; // 获取当前列属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var col = obj.col; // 获取当前列属性选项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
var layEvent = obj.event; // 获得自定义元素对应的 lay-event 属性值
|
||||
console.log(obj); // 查看对象所有成员
|
||||
});
|
||||
|
@ -721,8 +721,8 @@ table.render({
|
|||
|
||||
// 列拖拽宽度后的事件
|
||||
table.on('colResized(test)', function(obj){
|
||||
var col = obj.col; // 获取当前列属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var col = obj.col; // 获取当前列属性选项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
console.log(obj); // 查看对象所有成员
|
||||
});
|
||||
```
|
||||
|
@ -744,8 +744,8 @@ table.render({
|
|||
|
||||
// 列筛选(显示或隐藏)后的事件
|
||||
table.on('colToggled(test)', function(obj){
|
||||
var col = obj.col; // 获取当前列属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var col = obj.col; // 获取当前列属性选项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
console.log(obj); // 查看对象所有成员
|
||||
});
|
||||
```
|
||||
|
@ -774,7 +774,7 @@ table.on('row(test)', function(obj) {
|
|||
var dataCache = obj.dataCache; // 得到当前行缓存数据,包含特定字段 --- 2.8.8+
|
||||
var index = obj.index; // 得到当前行索引
|
||||
var tr = obj.tr; // 得到当前行 <tr> 元素的 jQuery 对象
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
var e = obj.e; // 当前的 jQuery 事件对象 --- 2.9.14+
|
||||
|
||||
console.log('onrow', obj); // 查看返回对象的所有成员
|
||||
|
@ -887,7 +887,7 @@ layui.use(function(){
|
|||
var index = obj.index; // 得到当前行索引
|
||||
var layEvent = obj.event; // 获得元素对应的 lay-event 属性值
|
||||
var tr = obj.tr; // 得到当前行 <tr> 元素的 jQuery 对象
|
||||
var options = obj.config; // 获取当前表格基础属性配置项
|
||||
var options = obj.config; // 获取当前表格基础属性选项
|
||||
var col = obj.getCol(); // 得到当前列的表头配置属性 -- v2.8.3 新增
|
||||
console.log(obj); // 查看对象所有成员
|
||||
|
||||
|
|
|
@ -30,7 +30,9 @@
|
|||
|
||||
<h3 id="demo-trigger" lay-toc="{level: 2}">自定义事件</h3>
|
||||
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full']}">
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full'], done: function(obj){
|
||||
obj.render();
|
||||
}}">
|
||||
<textarea>
|
||||
{{- d.include("/tabs/examples/trigger.md") }}
|
||||
</textarea>
|
||||
|
@ -40,7 +42,9 @@
|
|||
|
||||
切换 tabs 标签项后,地址栏同步 `hash` 值,当页面刷新时,tabs 仍保持对应的切换状态。
|
||||
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full']}">
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full'], done: function(obj){
|
||||
obj.render();
|
||||
}}">
|
||||
<textarea>
|
||||
{{- d.include("/tabs/examples/hash.md") }}
|
||||
</textarea>
|
||||
|
@ -48,7 +52,9 @@
|
|||
|
||||
<h3 id="demo-nest" lay-toc="{level: 2}">标签嵌套</h3>
|
||||
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full']}">
|
||||
<pre class="layui-code" lay-options="{preview: true, layout: ['preview', 'code'], codeStyle: 'max-height: 520px;', tools: ['full'], done: function(obj){
|
||||
obj.render();
|
||||
}}">
|
||||
<textarea>
|
||||
{{- d.include("/tabs/examples/nest.md") }}
|
||||
</textarea>
|
||||
|
|
|
@ -35,7 +35,7 @@ toc: true
|
|||
|
||||
`tabs.render(options)`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
组件支持以下三种渲染方式:
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@ toc: true
|
|||
|
||||
`transfer.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
<h3 id="options" lay-toc="{level: 2, hot: true}">属性</h3>
|
||||
|
||||
|
@ -46,7 +46,7 @@ toc: true
|
|||
`transfer.reload(id, options);`
|
||||
|
||||
- 参数 `id` : 对应渲染时定义的 `id` 属性值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
```
|
||||
var transfer = layui.transfer;
|
||||
|
@ -89,7 +89,7 @@ var getData = transfer.getData('test');
|
|||
|
||||
`transfer.set(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法对所有的 `transfer` 实例有效,设置的属性优先级低于 `transfer.render(options)`
|
||||
|
||||
|
@ -99,4 +99,4 @@ transfer.set({
|
|||
height: 'auto', // 所有穿梭框默认高度为自动
|
||||
// …
|
||||
});
|
||||
```
|
||||
```
|
||||
|
|
|
@ -27,7 +27,7 @@ toc: true
|
|||
|
||||
`tree.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
<h3 id="options" lay-toc="{level: 2, hot: true}">属性</h3>
|
||||
|
||||
|
@ -109,7 +109,7 @@ tree.setChecked('test', [1, 3]); // 批量勾选 id 为 1,3 的节点
|
|||
`tree.reload(id, idArr);`
|
||||
|
||||
- 参数 `id` : 对应 tree 渲染时定义的 id 属性值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
```
|
||||
var tree = layui.tree;
|
||||
|
@ -125,4 +125,4 @@ tree.render({
|
|||
tree.reload('test', { // options
|
||||
data: []
|
||||
});
|
||||
```
|
||||
```
|
||||
|
|
|
@ -124,7 +124,7 @@ treeTable.render({
|
|||
|
||||
| 属性 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
| enable | 是否开启异步加载模式。只有开启时 `async` 的其他属性配置才有效。 **注意:** 异步加载子节点不应跟 `simpleData` 同时开启,可以是 `url+simpleData` 的方式,获取完整的简单数据进行转换。若开启异步加载模式,即表示按需异步加载子节点。 | boolean | `false` |
|
||||
| enable | 是否开启异步加载模式。只有开启时 `async` 的其他属性选项才有效。 **注意:** 异步加载子节点不应跟 `simpleData` 同时开启,可以是 `url+simpleData` 的方式,获取完整的简单数据进行转换。若开启异步加载模式,即表示按需异步加载子节点。 | boolean | `false` |
|
||||
| url | 异步加载的接口,可以根据需要设置与顶层接口不同的接口,若相同可不设置该属性 | string | - |
|
||||
| [format](#options.tree.async.format) | 用于处理异步子节点数据的回调函数,该属性优先级高于 `async.url` 属性。用法详见下文。 | function | - |
|
||||
| type | 请求的接口类型,设置可缺省同上 | string | - |
|
||||
|
@ -146,7 +146,7 @@ treeTable.render({
|
|||
enable: true,
|
||||
async: {
|
||||
format: function(trData, options, callback){
|
||||
// trData 为行数据、options 为 treeTable 属性配置项
|
||||
// trData 为行数据、options 为 treeTable 属性选项
|
||||
// callbacck 为子节点的渲染函数
|
||||
// 可利用该函数对子节点数据进行异步请求或其他格式化处理
|
||||
var nodeList = [
|
||||
|
|
|
@ -47,7 +47,7 @@ toc: true
|
|||
|
||||
`treeTable.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该组件渲染的使用方式与 `table` 组件完全相同。
|
||||
|
||||
|
@ -69,7 +69,7 @@ toc: true
|
|||
| 仅数据重载 | treeTable.reloadData(id, options) |
|
||||
|
||||
- 参数 `id` : treeTable 渲染时的 id 属性值
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
使用方式与 `table` 组件完全相同,具体用法可参考:[table 重载](../table/#reload)
|
||||
|
||||
|
@ -144,7 +144,7 @@ console.log(obj);
|
|||
|
||||
- 参数 `id` : treeTable 渲染时的 `id` 属性值
|
||||
- 参数 `filter` : 过滤函数
|
||||
- 参数 `opts` : 该方法的属性可选项,详见下表:
|
||||
- 参数 `opts` : 该方法的属性选项,详见下表:
|
||||
|
||||
| 属性名 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
|
|
@ -27,13 +27,13 @@ toc: true
|
|||
| [var inst = upload.render(options)](#render) | upload 组件渲染,核心方法。 |
|
||||
| [inst.upload()](#upload) | 对当前实例提交上传 |
|
||||
| [inst.reload(options)](#reload) | 对当前实例进行重载 |
|
||||
| inst.config | 获得当前实例的属性配置项 |
|
||||
| inst.config | 获得当前实例的属性选项 |
|
||||
|
||||
<h3 id="render" lay-toc="{level: 2, hot: true}">渲染</h3>
|
||||
|
||||
`upload.render(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
<br>注 : 除 `elem` 属性外,其他基础属性也可以直接写在元素的 `lay-options="{}"` 属性中。
|
||||
|
||||
```
|
||||
|
@ -94,7 +94,7 @@ var inst = upload.render({
|
|||
|
||||
`inst.reload(options);`
|
||||
|
||||
- 参数 `options` : 基础属性配置项。[#详见属性](#options)
|
||||
- 参数 `options` : 基础属性选项。[#详见属性](#options)
|
||||
|
||||
该方法用于对当前的上传实例进行完整重载,所有属性均可参与到重载中。
|
||||
|
||||
|
|
|
@ -34,7 +34,7 @@ toc: true
|
|||
|
||||
`util.countdown(options);`
|
||||
|
||||
- 参数 `options` <sup>2.8.9+</sup>: 属性配置项。可选项详见下表:
|
||||
- 参数 `options` <sup>2.8.9+</sup>: 属性选项。可选项详见下表:
|
||||
|
||||
| 属性 | 描述 |
|
||||
| --- | --- |
|
||||
|
@ -101,7 +101,7 @@ var result = util.timeAgo(1672531200000); // 2023-01-01 00:00:00
|
|||
|
||||
- 参数 `time` : 毫秒数或日期对象
|
||||
- 参数 `format` : 日期字符格式。默认格式:`yyyy-MM-dd HH:mm:ss` 。可自定义,如: `yyyy年MM月dd日`
|
||||
- 参数 `options` <sup>2.8.13+</sup> : 该方法的属性可选项,详见下表:
|
||||
- 参数 `options` <sup>2.8.13+</sup> : 该方法的属性选项,详见下表:
|
||||
|
||||
| 属性名 | 描述 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
|
@ -179,7 +179,7 @@ var str2 = util.unescape('<div>123</div>'); // 返回: <div>123</d
|
|||
|
||||
`util.openWin(options);`
|
||||
|
||||
- 参数 `options` : 属性配置项。可选项详见下表
|
||||
- 参数 `options` : 属性选项。可选项详见下表
|
||||
|
||||
| 属性 | 描述 |
|
||||
| --- | --- |
|
||||
|
|
|
@ -49,6 +49,10 @@ toc: true
|
|||
|
||||
---
|
||||
|
||||
|
||||
|
||||
<h2 id="2.9.x" lay-toc="{title: '2.9.x'}"></h2>
|
||||
|
||||
<h2 id="v2.9.25" class="ws-anchor">
|
||||
v2.9.25
|
||||
<span class="layui-badge-rim">2025-03-13</span>
|
||||
|
@ -62,8 +66,6 @@ toc: true
|
|||
|
||||
---
|
||||
|
||||
<h2 id="2.9.x" lay-toc="{title: '2.9.x'}"></h2>
|
||||
|
||||
<h2 id="v2.9.24" class="ws-anchor">
|
||||
v2.9.24
|
||||
<span class="layui-badge-rim">2025-03-07</span>
|
||||
|
|
Loading…
Reference in New Issue