# Switch 开关
概述
Switch 开关选择器,原生组件增强。
# 支持平台
目前开发小程序与H5推荐使用 FirstUI nvue版本 (opens new window)。
安卓系统版本 | 安卓uni-app | 安卓uniapp-x | iOS系统版本 | iOS uniapp | iOS uniapp-x | 小程序 | H5/Web |
---|---|---|---|---|---|---|---|
5.0 | × | ✓ | 9.0 | × | × | × | ✓ |
# 引入
以下介绍两种常用的引入方式。
第一种:在页面中引用、注册
import fuiSwitch from "@/components/firstui/fui-switch/fui-switch.uvue"
export default {
components:{
fuiSwitch
}
}
1
2
3
4
5
6
2
3
4
5
6
第二种:easycom组件规范
传统vue组件,需要安装、引用、注册,三个步骤后才能使用组件。easycom将其精简为一步。
First UI easycom配置请查看 快速上手。
如果不了解easycom,可先查看 官网文档 (opens new window)。
# 代码演示
部分示例演示,完整使用请参考示例程序以及文档API。
基础使用
通过 change
事件获取打开关闭状态。
<fui-switch @change="change"></fui-switch>
1
export default {
data() {
return {
status: false
}
},
methods: {
change(checked : boolean) {
this.status = checked
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
默认打开
通过 checked
属性设置是否默认打开。
<fui-switch checked></fui-switch>
1
改变大小、颜色
通过 scaleRatio
属性来缩放组件大小,color
属性修改打开后颜色。
<fui-switch :scaleRatio="0.8" color="#FFB703"></fui-switch>
1
# Slots
插槽名称 | 说明 |
---|---|
default | 开关显示为switch时,圆形按钮内自定义内容 |
# Props
属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
---|---|---|---|---|
name | String | 开关选择器名称 | - | - |
checked | Boolean | 是否打开 | false | - |
disabled | Boolean | 是否禁用 | false | - |
disabledStyle | Boolean | 禁用后是否改变样式 | true | - |
type | String | 开关显示样式,有效值:switch, checkbox | switch | - |
color | String | 开关打开时颜色 | #465CFF | - |
normalColor | String | 开关未打开时背景色颜色 | #FFFFFF | - |
transitionColor | String | 开关过渡动画颜色,type=switch时生效 | #dfdfdf | - |
btnColor | String | 开关打开时按钮背景色, type=switch时生效 | #FFFFFF | - |
btnNormalColor | String | 开关关闭时按钮背景色,type=switch时生效 | #FFFFFF | - |
borderColor | String | 边框颜色,type=checkbox时生效 | #CCCCCC | - |
checkMarkColor | String | 对号颜色,type=checkbox时生效 | #fff | - |
scaleRatio | Number | 缩放比例,当比例大于1时,外层容器需要设置 overflow: visible或者留出足够空间,避免显示不全 | 1 | - |
scaleAlign | String | 缩放后对齐方式,可选值:left、center、right | center | - |
# Events
事件名 | 类型 | 说明 | 回调参数 |
---|---|---|---|
@change | (event: boolean) => void | 开关切换状态时触发 | boolean:是否打开 |
@update:checked | (event: boolean) => void | 开关切换状态时触发,用于双向绑定(v-model:checked) | boolean:是否打开 |