Toggle 开关
开关选择器,用于两个值之间的选择。
获取组件
import { Toggle } from 'rsuite';演示
默认
开关尺寸
颜色
带标签
文字和图标
可以通过 checkedChildren,unCheckedChildren 两个属性分别设置开关两种状态下显示的内容
禁用与只读
加载中
无障碍设计
ARIA 属性
- Toggle 具有
switchrole 。 - 当处于
checked状态时,Toggle 将aria-checked设置为true。 - 当处于
unchecked状态时,Toggle 将aria-checked设置为false。 - 当处于
loading状态时,Toggle 将aria-busy设置为true。 - 当处于
disabled状态时,Toggle 将aria-disabled设置为true。 - 当拥有
children时,Toggle 将aria-labelledby设置为children的 id。
键盘交互
- Space - 切换开关状态。
Props
<Toggle>
| 属性名称 | 类型 (默认值) |
描述 |
|---|---|---|
| checked | boolean | 指定当前是否选中 |
| checkedChildren | ReactNode | 选中显示的内容 |
| children | ReactNode | 开关的标签 |
| classPrefix | string ('toggle') |
组件 CSS 类的前缀 |
| color | Color | 开关颜色 |
| defaultChecked | boolean | 初始是否选中 |
| disabled | boolean | 禁用 |
| loading | boolean | 是否展示一个圈圈表示选中状态正在获取/更新 |
| locale | ToggleLocaleType | 定义本地化设置,使组件文本根据用户地区显示相应语言 |
| onChange | (checked: boolean, event) => void | 状态改变时的回调函数 |
| size | 'lg' | 'md' | 'sm' | 开关尺寸 |
| unCheckedChildren | ReactNode | 非选中显示的内容 |
Color
type Color = 'red' | 'orange' | 'yellow' | 'green' | 'cyan' | 'blue' | 'violet';