切换开关
用于在运行状态/关闭状态之间转动的切换组件.
安装
npm install @cleartrip/ct-design-toggle-switch
# or
pnpm add @cleartrip/ct-design-toggle-switch
同伴依赖关系
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
使用量
基础
import { ToggleSwitch } from '@cleartrip/ct-design-toggle-switch';
function Example() {
return (
<ToggleSwitch>
{/* Basic usage */}
</ToggleSwitch>
);
}
道具
| Prop | 类型 | 默认 | 需求 | 说明 |
|---|---|---|---|---|
checked | boolean | —— 说 | 没有 | 检查属性 |
disabled | boolean | —— 说 | 没有 | 残疾财产 |
onChange | (checked: boolean) => void | —— 说 | 没有 | 更改财产 |
prefix | 弦声 | 反弹 | —— 说 | 没有 |
suffix | 弦声 | 反弹 | —— 说 | 没有 |
size | ToggleSwitchSizeType | —— 说 | 没有 | 大小属性 |
styleConfig | { | —— 说 | 没有 | 样式属性 |
root | Styles[] | —— 说 | 没有 | 根属性 |
switch | Styles[] | —— 说 | 没有 | 切换属性 |
switchContainer | Styles[] | —— 说 | 没有 | 交换文件夹属性 |
switchWrapper | Styles[] | —— 说 | 没有 | 切换 |
labelStylesConfig | TextStyle[] | —— 说 | 没有 | 标签Stylesconfig 属性 |
切换切换大小
SMALL- 闪电LARGE- lg (英语)
无障碍
- 构成部分遵循无障碍最佳做法
- 确保在需要时提供适当的ARIA属性
- 用屏幕读取器测试以确保可用性
移徙
如果从上一版本迁移:
- import { ToggleSwitch } from 'yagami/core/components';
+ import { ToggleSwitch } from '@cleartrip/ct-design-toggle-switch';