Back to Layui

穿梭框组件 transfer

docs/transfer/index.md

2.13.62.1 KB
Original Source

穿梭框组件

穿梭框组件 transfer 以左右栏 checkbox 列表为表现形式,可对列表进行选择并移动到另一栏。

<h2 id="examples" lay-toc="{hot: true}" style="margin-bottom: 0;">示例</h2> <div> {{- d.include("/transfer/detail/demo.md") }} </div> <h2 id="api" lay-toc="{hot: true}">API</h2>
API描述
var transfer = layui.transfer获得 transfer 模块。
基础接口 <sup>2.13+</sup>该组件由 component 构建,因此继承其提供的基础接口。
transfer.render(options)transfer 组件渲染,核心方法。
transfer.reload(id, options)重载实例
transfer.getData(id)获得右侧数据
<h3 id="render" lay-toc="{level: 2}">渲染</h3>

transfer.render(options);

<h3 id="options" lay-toc="{level: 2, hot: true}">属性</h3> <div> {{- d.include("/transfer/detail/options.md") }} </div> <h3 id="options.data" lay-toc="{level: 3, hot: true}">data 格式</h3> <div> {{- d.include("/transfer/detail/options.data.md") }} </div> <h3 id="reload" lay-toc="{level: 2}">重载</h3>

transfer.reload(id, options);

  • 参数 id : 对应渲染时定义的 id 属性值
  • 参数 options : 基础属性选项。#详见属性
var transfer = layui.transfer;

// 渲染
transfer.render({
  elem: '', // 绑定元素选择器
  id: 'test', // 自定义 id 索引
  // 其他属性 …
});
// 重载
transfer.reload('test', { // options
  title: ['title 1', 'title 2']
});
<h3 id="getData" lay-pid="api" class="ws-anchor ws-bold">获得右侧数据</h3>

transfer.getData(id);

  • 参数 id : 对应渲染时定义的 id 属性值

穿梭框的右侧数据通常被认为是选中数据,因此你需要得到它,并进行提交等操作。

var transfer = layui.transfer;

// 渲染
transfer.render({
  elem: '', // 绑定元素选择器
  id: 'test', // 自定义 id 索引
  // 其他属性 …
});
// 获得右侧数据
var getData = transfer.getData('test');