适用于有开关按钮的列表项场景。
示例图


基础用法
页面 .json 文件 usingComponents 中引入组件
// json
{
"usingComponents": {
"mx-list-basic": "/components/mxwui/list-switch/index"
}
}页面 .wxml 文件中使用组件
<mx-list-switch />更多用法示例
标签文本 label
属性:label,简单的文本,不要太长。必填字段。
<mx-list-switch label="标签文本" />标签文本文本色 labelColor
属性:labelColor,默认 #040A23,支持任何合法的颜色值。
需要配合 label 属性一起使用。
<mx-list-switch labelColor="#CA0E2D" />文案对齐方式 labelAlign
属性:labelAlign,可选值:left、center、right,默认 left,左对齐。
需要配合 label 属性一起使用。
- 左对齐
<mx-list-switch />
<mx-list-switch labelAlign="left" />- 居中对齐
<mx-list-switch labelAlign="center" />- 右对齐
<mx-list-switch labelAlign="right" />左侧自定义宽度 leftWidth
属性:leftWidth,数字,不带单位,默认使用rpx。
不设置时左侧宽度自动计算。
<mx-list-switch leftWidth="200" />是否必填 required
属性:required,默认 false 非必填。
- 必填
<mx-list-switch required />
<mx-list-switch required={{true}} />- 非必填
<mx-list-switch required={{false}} />
<mx-list-switch />必填星号位置 requiredPosition
属性:requiredPosition,可选值:left、right,默认 right 默认在标签文本右侧。
- 星号在标签文本右侧
<mx-list-switch label="在右侧" />
<mx-list-switch label="在右侧" requiredPosition />
<mx-list-switch label="在右侧" requiredPosition="right" />- 星号在标签文本左侧
<mx-list-switch label="在左侧" requiredPosition="left" />标签前图标 firstIcon
属性:firstIcon,图标配置。
参数:iconName,图标名称,只支持图标库中的图标。
参数:iconColor,图标颜色,默认 #040A23,支持任何合法的颜色值。
参数:iconUrl,自定义图片地址,传入则 iconName 和 iconColor 无效。
参数:iconSize,图标/图片大小,支持大小设置,默认为 48,不带单位,默认使用rpx。
事件:bind:list_switch_firstIcon,标签前图标点击事件
- 自定义图标
<mx-list-switch firstIcon="{{firstIcon}}" />// js
data: {
firstIcon: {
iconName: '图标名称',
iconColor: '#CA0E2D',
iconSize: 40
},
}- 自定义图片
<mx-list-switch firstIcon="{{firstIcon}}" />// js
data: {
firstIcon: {
iconUrl: 'https://cdn.mingsixue.com/xcx/MXWUI/hot.png',
iconSize: 40
},
}标签后图标 lastIcon
属性:lastIcon,图标配置。
参数:iconName,图标名称,只支持图标库中的图标。
参数:iconColor,图标颜色,默认 #9AA0B1,支持任何合法的颜色值。
参数:iconUrl,自定义图片地址,传入则 iconName 和 iconColor 无效。
参数:iconSize,图标/图片大小,支持大小设置,默认为 32,不带单位,默认使用rpx。
事件:bind:list_switch_lastIcon,标签后图标点击事件
- 自定义图标
<mx-list-switch lastIcon="{{lastIcon}}" />// js
data: {
lastIcon: {
iconName: '图标名称',
iconColor: '#CA0E2D',
iconSize: 40
},
}- 自定义图片
<mx-list-switch lastIcon="{{lastIcon}}" />// js
data: {
lastIcon: {
iconUrl: 'https://cdn.mingsixue.com/xcx/MXWUI/hot.png',
iconSize: 40
},
}描述 desc
属性:desc,辅助性描述内容。
<mx-list-switch desc="描述内容描述内容描述内容" />描述文本色 descColor
属性:descColor,默认 #9AA0B1,支持任何合法的颜色值。
<mx-list-switch descColor="#CA0E2D" />是否显示分隔线 showLine
属性:showLine,默认 true 显示分隔线。
- 显示分隔线
<mx-list-switch />
<mx-list-switch showLine />
<mx-list-switch showLine="{{true}}" />- 不显示分隔线
<mx-list-switch showLine="{{false}}" />Switch是否选中 checked
属性:checked,默认 false 默认未选中。
- 选中
<mx-list-switch checked />
<mx-list-switch checked="{{true}}" />- 未选中
<mx-list-switch checked="{{false}}" />
<mx-list-switch />Switch是否禁用 disabled
属性:disabled,默认 false 默认未禁用。
- 禁用
<mx-list-switch disabled />
<mx-list-switch disabled="{{true}}" />- 未禁用
<mx-list-switch disabled="{{false}}" />
<mx-list-switch />Switch颜色
属性:switchColor,默认 #098562,支持任何合法的颜色值。
<mx-list-switch switchColor="#CA0E2D" />#事件
事件:bind:list_switch_firstIcon,标签前图标点击事件
事件:bind:list_switch_lastIcon,标签后图标点击事件
事件:bind:list_switch_change,Switch开关事件
<mx-list-switch
label="事件"
firstIcon="{{firstIcon}}"
lastIcon="{{lastIcon}}"
bind:list_switch_firstIcon="handleFirstIcon"
bind:list_switch_lastIcon="handleLastIcon"
bind:list_switch_change="handleSwitchChange"
/>参数
| 参数 | 类型 | 必填 | 可选值 | 默认值 | 参数描述 |
|---|---|---|---|---|---|
| label | String | 是 | 标签文案 | ||
| labelColor | String | 颜色值 | #040A23 |
标签文案文本色,支持任何合法的颜色值 | |
| labelAlign | String | left、center、right |
left |
标签对齐方式 | |
| leftWidth | Number | 数字 | 左侧自定义宽度,不带单位,默认rpx | ||
| required | Boolean | true、false |
false |
是否必填 | |
| requiredPosition | String | left、right |
right |
必填星号位置 | |
| firstIcon | Object | 标签前图标 | |||
| lastIcon | Object | 标签后图标 | |||
| desc | String | 描述 | |||
| descColor | String | 颜色值 | #9AA0B1 |
描述文本色,支持任何合法的颜色值 | |
| showLine | Boolean | true、false |
true |
是否显示分隔线 | |
| checked | Boolean | true、false |
false |
是否选中 | |
| disabled | Boolean | true、false |
false |
是否禁用 | |
| switchColor | String | 颜色值 | #098562 |
Switch颜色 |
firstIcon
| 参数 | 类型 | 默认值 | 参数描述 |
|---|---|---|---|
| iconName | String | 图标名称,只支持图标库中图标 | |
| iconColor | String | #040A23 |
图标颜色,任何合法的颜色值 |
| iconUrl | String | 图标图片地址,传入则 iconName、iconColor 无效 |
|
| iconSize | Number | 48 |
图标大小,不带单位,默认rpx |
lastIcon
| 参数 | 类型 | 默认值 | 参数描述 |
|---|---|---|---|
| iconName | String | 图标名称,只支持图标库中图标 | |
| iconColor | String | #9AA0B1 |
图标颜色,任何合法的颜色值 |
| iconUrl | String | 图标图片地址,传入则 iconName、iconColor 无效 |
|
| iconSize | Number | 32 |
图标大小,不带单位,默认rpx |
事件
| 事件名称 | 类型 | 返回值 | 事件说明 |
|---|---|---|---|
| bind:list_switch_firstIcon | Click | 标签前图标点击事件 | |
| bind:list_switch_lastIcon | Click | 标签后图标点击事件 | |
| bind:list_switch_change | Change | event.detail |
Switch开关事件,返回字段 value,值为 true 或 false |
其他说明
无