uv-ui

# Switch 开关选择器

✈

组件名：uv-switch

点击下载&安装 (opens new window)

选择开关用于在打开和关闭状态之间进行切换。

# 平台兼容性

App（vue） App（nvue） H5 小程序 VUE2 VUE3
√ √ √ √ √ √

# 基础使用

通过v-model绑定一个布尔值变量，这个变量是双向绑定的，当用户开或关选择器的时候，在父组件的该值也会相应的变为true或者false，也就是说， 您不用监听change事件，也能知道选择器当前处于开或者关的状态。

我们为其提供了加载中 禁用 自定义尺寸 自定义颜色 自定义样式 异步控制等六种能力，并在以下案例中为您展示

<template>
	<uv-switch v-model="value"></uv-switch>
</template>
<script>
	export default {
		data() {
			return {
				value: true
			}
		}
	};
</script>

# 加载中

设置loading属性，默认为true，可以让switch处于加载中的状态，这时switch是不可操作的，您可以通过:loading='loading'以动态设置加载状态

<template>
	<view>
		<uv-switch v-model="value" loading></uv-switch>
		<uv-switch v-model="value2" loading></uv-switch>
	</view>
</template>
<script>
	export default {
		data() {
			return {
				value: false,
				value2: true
			}
		}
	};
</script>

# 禁用switch

设置disabled属性,默认为true，即可禁用某个组件，让用户无法点击，禁用分为两种状态：

  • 一是关闭情况下的禁用，这时只显示一个白色的区域。
  • 二是打开后再禁用，这时会在原有的颜色上加一个opacity透明度，但此时依然是不可操作的。
<template>
	<view>
		<uv-switch v-model="value" disabled></uv-switch>
		<uv-switch v-model="value2" disabled></uv-switch>
	</view>
</template>
<script>
	export default {
		data() {
			return {
				value: false,
				value2: true
			}
		}
	};
</script>

# 自定义尺寸

设置size属性，可以让您自定义switch的尺寸，可自定义单位

<template>
	<view>
		<uv-switch v-model="value" size="28"></uv-switch>
		<uv-switch v-model="value2" size="20"></uv-switch>
		<uv-switch v-model="value2" size="30rpx"></uv-switch>
	</view>
</template>
<script>
	export default {
		data() {
			return {
				value: false,
				value2: true
			}
		}
	};
</script>

# 自定义颜色

设置activeColor属性，可以让您自定义switch的颜色，支持多种设置方式，如：activeColor="#f56c6c" activeColor="red" activeColor="rgb(0,0,0)"

<template>
	<view>
		<uv-switch v-model="value" activeColor="#f56c6c"></uv-switch>
	</view>
</template>
<script>
	export default {
		data() {
			return {
				value: true
			}
		}
	};
</script>

# 自定义样式

同时设置activeColor和inactiveColor属性，可以让您自定义switch的样式，同样支持多种设置方式

<template>
	<view>
		<uv-switch v-model="value" inactive-color="#f3f4f6" active-color="#3c9cff"></uv-switch>
	</view>
</template>
<script>
	export default {
		data() {
			return {
				value: false
			}
		}
	};
</script>

# 异步控制

异步控制场景，一般发生在用户打开或者关闭选择器时，需要本地或者向后端请求判断，是否允许用户打开或者关闭的场景。
同时您也可以组合使用，例如根据接口结果添加disabled，loading属性等

注意

请添加asyncChange属性来支持异步控制操作，否则您将先操作v-model绑定的值，并失去控制效果

<template>
	<uv-switch v-model="value" asyncChange @change="asyncChange"></uv-switch>
</template>
<script>
	export default {
		data() {
			return {
				value: true
			};
		},
		methods: {
			asyncChange(e) {
				uni.showModal({
					content: e ? '确定要打开吗' : '确定要关闭吗',
					success: (res) => {
						if (res.confirm) {
							this.value = e;
						}
					}
				})
			}
		}
	};
</script>

# 完整示例

完整示例下载地址

https://ext.dcloud.net.cn/plugin?name=uv-ui (opens new window)

# API

# Switch Props

  • 注意：需要给switch组件通过v-model绑定一个布尔值，来初始化switch的状态，随后该值被双向绑定， 当用打开选择器时，该值在switch组件内部被修改为true，并反映到父组件，否则为false。换言之，您无需监听switch的change事件，也能 知道某一个switch是否被选中的状态。
  • v-model绑定的值必须为inactiveValue、activeValue二者之一，且inactiveValue和activeValue的值不能相等。
参数 说明 类型 默认值 可选值
v-model 双向绑定的值，注意：这里只能使用v-model，不能使用:value Boolean | String | Number false -
loading 是否处于加载中 Boolean false true | false
disabled 是否禁用 Boolean false true | false
size 开关尺寸，单位rpx String | Number 25 -
activeColor 打开时的背景色 String #2979ff -
inactiveColor 关闭时的背景色 String #ffffff -
activeValue switch打开时的值 Boolean | String | Number true -
inactiveValue switch关闭时的值 Boolean | String | Number false -
asyncChange 是否开启异步变更，开启后需要手动控制输入值 Boolean false true | false
space 圆点与外边框的距离 String | Number 0 -

# Switch Events

事件名 说明 回调参数
@change 在switch打开或关闭时触发 value：打开时为activeValue值，关闭时为inactiveValue值
@input 在switch打开或关闭时触发（没开启异步） value：打开时为activeValue值，关闭时为inactiveValue值

← Calendar 日历 →