SxListbox (列表框)
静态可见的选项列表选择器。对齐 Microsoft Fluent UI Blazor Listbox (v4.13.2) 的 API 结构,并说明 NextUI 当前实现状态。
使用场景
- 小型列表选项选择
- 多选列表设置
- 固定高度的选项列表
约束说明
Items 为空时显示空状态。
Multiple 为真时使用 SelectedOptions。
行为说明
- 点击选项触发
ValueChanged 或 SelectedOptionsChanged。
ReadOnly 或 Disabled 时不可选择。
API
Parameters (参数)
| 状态 |
参数名 |
类型 |
默认值 |
描述 |
| Implemented |
Items |
IEnumerable<TValue>? |
null |
选项数据源集合。 |
| Implemented |
Value |
TValue? |
default |
当前选中的单选值。 |
| Implemented |
SelectedOptions |
IEnumerable<TValue>? |
null |
多选模式下选中的值集合。 |
| Implemented |
Multiple |
bool |
false |
是否开启多选模式。 |
| Implemented |
OptionTemplate |
RenderFragment<TValue>? |
null |
选项渲染模版。 |
| Implemented |
LabelSelector |
Func<TValue, string>? |
null |
选项文本选择器。 |
| Implemented |
Label |
string? |
null |
顶部标签文本。 |
| Implemented |
Appearance |
SxInputAppearance |
Outline |
视觉风格。 |
| Implemented |
Autofocus |
bool |
false |
自动聚焦。 |
| Implemented |
AriaLabel |
string? |
null |
aria-label。 |
| Implemented |
ReadOnly |
bool |
false |
是否只读。 |
| Implemented |
Required |
bool |
false |
是否必填。 |
| Implemented |
Height |
string? |
null |
列表最大高度。 |
| Implemented |
Width |
string? |
null |
固定宽度。 |
| 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 |
SelectedOptionsChanged |
EventCallback<IEnumerable<TValue>?> |
多选模式下选中项集合改变时触发。 |
| Implemented |
ValueChanged |
EventCallback<TValue?> |
值改变时触发。 |
示例
<SxListbox TValue="string" Items="_items" @bind-Value="_value" />
参考设计 (References)