Skip to content
本页导读

Switch

组件类型:UxSwitchComponentPublicInstance

扩展官方组件

平台兼容性

UniApp X

AndroidiOSweb鸿蒙 Next小程序
x

UniApp Vue Nvue

AndroidiOSweb鸿蒙 Next小程序
xxxx

Props

属性名类型默认值说明
nameString表单的控件名称,作为键值对的一部分与表单(form组件)一同提交
themeString主题颜色
checkedBooleanfalse是否选中
sizeStringnormal尺寸
colorString$ux.Conf.primaryColor颜色
darkColorString深色none-不显示,auto-自动适配深色模式,其他-颜色
marginArray边距[上右下左][上下左右][上下左右]
mtAny距上单位px
mrAny距右单位px
mbAny距下单位px
mlAny距左单位px
paddingArray填充[上右下左][上下左右][上下左右]
ptAny上内边距单位px
prAny右内边距单位px
pbAny下内边距单位px
plAny左内边距单位px
xstyleArray自定义样式
disabledBooleanfalse是否禁用

theme

说明
primary主色
warning警告
success成功
error错误
info文本

size

说明
normal正常
small小尺寸
large大尺寸

darkColor

说明
none不显示
auto自动适配深色模式
color其他颜色

Events

事件名说明参数
change值改变时触发

示例代码

html
<template>
	<ux-page :stack="showDoc">
		<ux-navbar :title="title" :bold="true">
			<template v-slot:right>
				<!-- #ifndef MP -->
				<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
				<!-- #endif -->
			</template>
		</ux-navbar>
		
		<ux-scroll>
			<ux-card direction="column" icon="flag-filled" title="开关选择器" :bold="true">
				<ux-text text="基于官方Switch扩展组件"></ux-text>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="主题" :bold="true">
				<ux-text text="多种主题可配置,适配暗黑模式" :mb="15"></ux-text>
				<ux-row>
					<ux-switch theme="primary" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="warning" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="success" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="error" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="尺寸" :bold="true">
				<ux-text text="支持大中小尺寸" :mb="15"></ux-text>
				<ux-row>
					<ux-switch size="small" :checked="checked" @change="change"></ux-switch>
					<ux-switch :checked="checked" @change="change"></ux-switch>
					<ux-switch size="large" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="禁用" :bold="true">
				<ux-text text="禁用组件" :mb="15"></ux-text>
				<ux-row>
					<ux-switch :disabled="true" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-placeholder :height="200">
				<ux-row justify="center" align="center" style="height: 100%;">
					<ux-text prefix-icon="soapbubble-filled" text="真的没有了~"></ux-text>
				</ux-row>
			</ux-placeholder>
		</ux-scroll>
		
	</ux-page>
</template>
<template>
	<ux-page :stack="showDoc">
		<ux-navbar :title="title" :bold="true">
			<template v-slot:right>
				<!-- #ifndef MP -->
				<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
				<!-- #endif -->
			</template>
		</ux-navbar>
		
		<ux-scroll>
			<ux-card direction="column" icon="flag-filled" title="开关选择器" :bold="true">
				<ux-text text="基于官方Switch扩展组件"></ux-text>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="主题" :bold="true">
				<ux-text text="多种主题可配置,适配暗黑模式" :mb="15"></ux-text>
				<ux-row>
					<ux-switch theme="primary" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="warning" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="success" :checked="checked" @change="change"></ux-switch>
					<ux-switch theme="error" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="尺寸" :bold="true">
				<ux-text text="支持大中小尺寸" :mb="15"></ux-text>
				<ux-row>
					<ux-switch size="small" :checked="checked" @change="change"></ux-switch>
					<ux-switch :checked="checked" @change="change"></ux-switch>
					<ux-switch size="large" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-card direction="column" icon="arrowright" title="禁用" :bold="true">
				<ux-text text="禁用组件" :mb="15"></ux-text>
				<ux-row>
					<ux-switch :disabled="true" :checked="checked" @change="change"></ux-switch>
				</ux-row>
			</ux-card>
			
			<ux-placeholder :height="200">
				<ux-row justify="center" align="center" style="height: 100%;">
					<ux-text prefix-icon="soapbubble-filled" text="真的没有了~"></ux-text>
				</ux-row>
			</ux-placeholder>
		</ux-scroll>
		
	</ux-page>
</template>
ts
<script setup>
	
	import * as plus from '@/uni_modules/ux-plus'

	import { UxSwitchEvent } from '@/uni_modules/ux-frame'

	const title = ref('')
	const checked = ref(false)
	const showDoc = ref(false)
	
	function onDoc() {
		plus.openWeb({
			title: '在线文档',
			url: 'https://www.uxframe.cn/component/switch.html',
			// blur: 1,
			success: () => {
				showDoc.value = true
			},
			complete: () => {
				showDoc.value = false
			}
		})
	}
	
	onLoad((e) => {
		title.value = e['title'] ?? ''
	})
	
	function change(e: UxSwitchEvent) {
		checked.value = e.value
	}
</script>
<script setup>
	
	import * as plus from '@/uni_modules/ux-plus'

	import { UxSwitchEvent } from '@/uni_modules/ux-frame'

	const title = ref('')
	const checked = ref(false)
	const showDoc = ref(false)
	
	function onDoc() {
		plus.openWeb({
			title: '在线文档',
			url: 'https://www.uxframe.cn/component/switch.html',
			// blur: 1,
			success: () => {
				showDoc.value = true
			},
			complete: () => {
				showDoc.value = false
			}
		})
	}
	
	onLoad((e) => {
		title.value = e['title'] ?? ''
	})
	
	function change(e: UxSwitchEvent) {
		checked.value = e.value
	}
</script>
css
<style lang="scss">
	
</style>
<style lang="scss">
	
</style>