SxSwitch (开关)
二元状态切换组件。对齐 Microsoft Fluent UI Blazor Switch (v4.13.2) 的 API 结构,并说明 NextUI 当前实现状态。
使用场景
约束说明
LabelOn/LabelOff 仅在对应状态显示。
ReadOnly 或 Disabled 时不允许切换。
行为说明
- 值变化触发
ValueChanged。
ReadOnly 状态下仅展示不响应交互。
API
Parameters (参数)
| 状态 |
参数名 |
类型 |
默认值 |
描述 |
| Implemented |
Value |
bool |
false |
当前状态。 |
| Implemented |
Label |
string? |
null |
主标签文本。 |
| Implemented |
LabelOn |
string? |
null |
开启状态文本。 |
| Implemented |
LabelOff |
string? |
null |
关闭状态文本。 |
| Implemented |
ReadOnly |
bool |
false |
是否只读。 |
| Implemented |
Required |
bool |
false |
是否必填。 |
| Implemented |
Autofocus |
bool |
false |
自动聚焦。 |
| Implemented |
AriaLabel |
string? |
null |
aria-label。 |
| Implemented |
AccessKey (继承) |
string? |
null |
快捷键。 |
| Implemented |
TabIndex (继承) |
int? |
null |
Tab 顺序。 |
| Implemented |
Disabled (继承) |
bool |
false |
禁用状态。 |
| Implemented |
Id (继承) |
string? |
null |
组件的物理 Id。 |
| Implemented |
Class (继承) |
string? |
null |
自定义 CSS 类名。 |
| Implemented |
Style (继承) |
string? |
null |
自定义样式。 |
| Implemented |
Title (继承) |
string? |
null |
HTML title 属性。 |
| Implemented |
AdditionalAttributes (继承) |
IEnumerable<KeyValuePair<string, object>>? |
null |
捕获不匹配的 HTML 属性。 |
Events (事件)
| 状态 |
事件名 |
类型 |
描述 |
| Implemented |
ValueChanged |
EventCallback<bool> |
状态改变时触发。 |
示例
<SxSwitch @bind-Value="_enabled" Label="开启通知" />
<SxSwitch @bind-Value="_enabled" LabelOn="ON" LabelOff="OFF" />
参考设计 (References)