选择器 Picker
选择器,提供单列、双列、级联能力。
使用
API用法示例
备注
options 字段数据结构:PickerAcronymColumn 或 PickerColomn
单列数据
简易属性模式:
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var value = ['选项二'];
var options = ['选项一', '选项二', '选项三', '选项四', '选项五'];
var tiPicker = document.getElementById("ti-picker");
tiPicker.value = value;
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
完整属性模式:
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var value = [
{ colAlias: 'a', value: '选项二' },
];
var options = {
colAlias: 'a',
column: ['选项一', '选项二', '选项三', '选项四', '选项五'],
};
var tiPicker = document.getElementById("ti-picker");
tiPicker.value = value;
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
多列数据
简易属性模式:
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var value = ['选项二', '选项三'];
var options = [
['选项一', '选项二', '选项三', '选项四', '选项五'],
['选项一', '选项二', '选项三', '选项四', '选项五']
];
var tiPicker = document.getElementById("ti-picker");
tiPicker.value = value;
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
完整属性模式:
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var value = [
{ colAlias: 'a', value: '选项二' },
{ colAlias: 'b', value: '选项三' },
];
var options = [
{
colAlias: 'a',
column: ['选项一', '选项二', '选项三', '选项四', '选项五'],
},
{
colAlias: 'b',
column: ['选项一', '选项二', '选项三', '选项四', '选项五'],
}
];
var tiPicker = document.getElementById("ti-picker");
tiPicker.value = value;
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
有禁用项
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var options = [
{ text: '选项一', disabled: true },
{ text: '选项二' },
{ text: '选项三', disabled: true },
{ text: '选项四' },
{ text: '选项五', disabled: true },
{ text: '选项六' },
];
var tiPicker = document.getElementById("ti-picker");
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
级联数据
- index.html
- index.js
code
<ti-picker id="ti-picker"></ti-picker>
window.onload = function(){
var options = [
{
code: '310000',
name: '上海市',
children: [
{
code: '310100',
name: '直辖市',
children: [
{
code: '310101',
name: '黄浦区',
},
],
},
],
},
{
code: '330000',
name: '浙江省',
children: [
{
code: '330100',
name: '杭州市',
children: [
{
code: '330102',
name: '上城区',
},
{
code: '330105',
name: '拱墅区',
},
],
},
],
},
];
var tiPicker = document.getElementById("ti-picker");
tiPicker.options = options;
tiPicker.addEventListener('confirm', function(e){
console.log(e);
}, false);
}
ti-picker API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
options | PickerColumn[] | PickerColumn[][] | PickerAcronymColumn[] | PickerAcronymColumn[][] | 否 | [] | 列数据;可以使用该字段实现 PickerColumn 列表, 替换使用 <ti-pickerColumn /> 元素。 | - |
value | 否 | - | - | ||
row-alias | null | number | string | 否 | null | 当 option 为对象类型时,指定其中某个字段,作为返回值字段;不填则从0 自增 | |
use-row-index | boolean | 否 | false | 是否使用下标 | |
sports | boolean | 否 | false | 跳转指定位置是否带有动画 | - |
cascade | boolean | 否 | false | 级联 | - |
label | string | 否 | 'label' | 当 option 为对象类型时,设置某个字段作为展示字段 | - |
visible-item-count | number | 否 | 展示项数 | - | |
loading | boolean | 否 | false | 是否展示加载中 | - |
option-item-height | string | number | 否 | 108rpx | 单项高度,单位px | - |
titlebar | boolean | 否 | true | 是否使用 TiPopupTitlebar 组件 | - |
title | string | 否 | '' | 标题文案,透传给 TiPopupTitlebar | |
sub-title | string | 否 | '' | 副标题文案,透传给 TiPopupTitlebar | |
confirm-text | string | 否 | 确定 | 确认按钮文案,透传给 TiPopupTitlebar | |
cancel-text | string | 否 | 取消 | 取消按钮文案,透传给 TiPopupTitlebar | |
ext-style | string | 否 | '' | 容器样式 | - |
ext-option-style | string | 否 | '' | 子器样式 | - |
Options 字段类型说明
值类型 | 说明 | 备注 |
---|---|---|
PickerColumn[] | 完整列,单列数组 | — |
PickerColumn[][] | 完整列,双列数组 | — |
PickerAcronymColumn[] | 简易列,单列数组 | — |
PickerAcronymColumn[][] | 简易列,双列数组 | — |
事件 Events
名称 | 参数 | 说明 | 备注 |
---|---|---|---|
change | 见 change | select 事件返回值 | 当前选中项 | - |
reach-top | 见 reachTop /reachBottom 事件返回值 | 运动到顶 | - |
reach-bottom | 见 reachTop /reachBottom 事件返回值 | 运动到底 | - |
confirm | 见 confirm /cancel 事件返回值 | title-bar 的确认操作 | titlebar:true |
cancel | 见 confirm /cancel 事件返回值 | title-bar 的取消操作 | titlebar:true |
插槽 Slots
名称 | 说明 | 备注 |
---|---|---|
default | picker-column | — |
header | titlebar下方区域 | — |
外部样式类 External Classes
名称 | 说明 | 备注 |
---|---|---|
ext-hairline-class | 中间线样式 | - |
ext-mask-class | 蒙层样式 | - |
ext-option-class | 纵列容器样式 | - |
ext-option-item-class | 纵列单项样式 | - |
ext-class | 容器样式 | - |
CSS 变量 CSS Variables
变量 | 默认值 | 说明 |
---|---|---|
--picker-mask-bg-image | linear-gradient(180deg, rgba(255, 255, 255, 90%), rgba(255, 255, 255, 40%)) | 蒙层区背景色 |
--picker-loading-bg-color | theme.color.gray.background.default | loading 区背景色 |
--picker-row-color | theme.color.gray.texticon.900 | 同 picker-column 组件 --picker-column-row-color |
--picker-row-selected-color | theme.color.gray.texticon.900 | 同 picker-column 组件 --picker-column-row-selected-color |
--picker-row-disabled-color | theme.color.gray.texticon.250 | 同 picker-column 组件 --picker-column-row-disabled-color |
--picker-row-selected-font-size | theme.fontSize.t9 | 选中文字,字号 |
--picker-row-selected-line-height | theme.lineHeight.multiline.t6 | 选中文字,行高 |
--picker-row-selected-font-weight | theme.fontWeight.semibold | 选中文字,字重 |
--picker-row-font-size | theme.fontSize.t8 | 未选中文字,字号 |
--picker-row-line-height | theme.lineHeight.multiline.t3 | 未选中文字,行高 |
--picker-row-font-weight | theme.fontWeight.regular | 未选中文字,字重 |
--picker-row-selected-padding-v | theme.spacing.vertical.v8 | 选中文字,选中项内,上下padding |
--picker-row-padding-v | theme.spacing.vertical.v9 | 未选中文字,选中项内,上下padding |
ti-picker-column API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
col-alias | string | number | 否 | null | PickerColumn 的别名; 多列时有用 | - |
row-alias | string | 否 | '' | 当 option 为对象类型时,指定其中某个字段的值,作为返回值中的 value | - |
value | string | number | 否 | null | 默认选中项 | - |
columns | string[] | number[] | object[] | 否 | [] | 列数据 | - |
sports | boolean | 否 | false | columns 或者 value 发生变化时候是否展示动画 | - |
label | string | 否 | label | 当 option 为对象类型时,指定其中某个字段的值,作为展示文案 | - |
use-row-index | boolean | 否 | false | 是否使用下标 | - |
ext-style | string | 否 | '' | 容器样式 | - |
事件 Events
名称 | 参数 | 说明 | 备注 |
---|---|---|---|
select | 见 change | select 事件返回值 | 当前选中项 | - |
reachTop | 见 reachTop /reachBottom 事件返回值 | 运动到顶时触发 | - |
reachBottom | 见 reachTop /reachBottom 事件返回值 | 运动到底时触发 | - |
外部样式类 External Classes
名称 | 说明 | 备注 |
---|---|---|
ext-class | 容器样式 | ---- |
CSS 变量 CSS Variables
变量 | 默认值 | 说明 |
---|---|---|
--picker-column-row-color | theme.color.gray.texticon.900 | 文字颜色 |
--picker-column-row-selected-color | theme.color.gray.texticon.900 | 选中文字颜色 |
--picker-column-row-disabled-color | theme.color.gray.texticon.250 | 禁用文字颜色 |
数据结构 Data Structure
列数据结构 PickerColumn
字段 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
col-alias | string | number | symbol | 否 | 类型 | 列别名,不填则从0 自增 |
column | PickerAcronymColumn[] | 否 | 类型 | 列数据 |
id | string | 否 | 默认值 | id |
is-tree | boolean | 否 | 默认值 | 是否为树形结构 |
children | undefined | 否 | 默认值 | 子数据 |
column-id | string | 否 | 默认值 | 唯一id |
[key: string] | unknown | 否 | label | 展示文案的字段,与 label 字段的值对应 |
简易模式 / 列数据结构 PickerAcronymColumn
简易模式下,传入的字段同时作为每一项的 key 和 value。
type PickerAcronymColumn = string | { [key: string]: unknown, disabled?: boolean };
change
| select
事件返回值
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
value | unknow | 类型 | - |
options | undefined | 集合 | |
col-index | string | number | 列索引 | |
col-alias | string | 列别名 | |
row-index | string | number | 行索引 | |
row-alias | boolean | 行别名 |
reachTop
| reachBottom
事件返回值
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
col-index | string | number | 列索引 | - |
row-index | string | number | 行索引 | - |
col-alias | string | 列别名 | - |
confirm
| cancel
事件返回值
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
value | PickerAcronymColumn | PickerAcronymColumn[] | PickerColumn | PickerColumn[] | 返回 value 字段 | - |
options | PickerAcronymColumn | PickerAcronymColumn[] | PickerColumn | PickerColumn[] | 返回选中的整个 option | - |