Toggle 开关
Toggle 适合立即生效的双态切换。和 Checkbox 更偏向“标记后统一提交”不同,Toggle 更适合通知、同步、权限和偏好设置。
Rue 使用当前 toggle 视觉类,并提供了 Switch 常见的受控/非受控、状态文案、loading 和设置项布局能力。
# 基础受控
当前状态:已启用
# 文本与图标
图标态:网络已接通
# Loading
# Toggle colors
# Toggle sizes
# Disabled
# 设置项布局
API
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
checked | 受控选中状态 | boolean | - |
checkedChildren | 选中态展示内容,适合短文本或图标 | any | - |
children | 附加说明内容,传入后会自动包裹为设置项布局 | any | - |
color | 开关颜色主题 | 'primary' | 'secondary' | 'accent' | 'neutral' | 'success' | 'warning' | 'info' | 'error' | - |
contentClassName | 设置项内容容器类名 | string | - |
defaultChecked | 非受控初始选中状态 | boolean | false |
defaultValue | 别名;传 boolean 时等价于 defaultChecked,传 string 或 number 时作为原生默认值 | boolean | string | number | - |
disabled | 禁用开关 | boolean | false |
loading | 加载态,同时自动禁用当前开关 | boolean | false |
onChange | 状态变化时回调,签名为 (checked, event) | (checked: boolean, event: Event) => void | - |
onCheckedChange | 语义化别名回调,签名同 onChange | (checked: boolean, event: Event) => void | - |
onClick | 点击开关时回调,签名为 (checked, event) | (checked: boolean, event: Event) => void | - |
rootClassName | 设置项根容器类名 | string | - |
size | 尺寸,支持 xs 到 xl,也支持 small、default、medium 语义别名 | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'small' | 'default' | 'medium' | - |
stateClassName | 状态文案区域类名 | string | - |
unCheckedChildren | 未选中态展示内容 | any | - |
value | 别名;传 boolean 时等价于 checked,传 string 或 number 时作为原生 input 值 | boolean | string | number | - |