SxDrawer UI 设计规范

自动生成时间: 2026-02-04 组件路径: src/NextUI.Blazor/Components/SxDrawer.razor

1. 组件概述

  • 组件包含 5 个参数,0 个回调,0 个公开方法。
  • 内部组合组件:SxButton。

2. 组件模式

模式 条件 说明
条件渲染 !string.IsNullOrEmpty(HeaderText 影响局部渲染块
条件渲染 Footer != null 影响局部渲染块

3. 表单字段

字段组件 绑定
- -

4. 操作按钮

外观 动作/链接 禁用条件
ButtonAppearance.Stealth Close -

5. 验证规则

未检测到显式验证标记。

6. 状态与流程

内部状态字段: 未检测到明确状态字段。

7. 公共 API

7.1 Parameters

参数 类型 默认值 说明
HeaderText string ""
Position DrawerPlacement DrawerPlacement.Right
Width string? "320px"
PositioningMode SxDrawerPositioningMode SxDrawerPositioningMode.Fixed
OverlayMode SxDrawerOverlayMode SxDrawerOverlayMode.Default

7.2 Public Methods

无公开方法。

7.3 Events/Callbacks

无回调事件。

8. 典型使用场景 (Use Cases)

8.1 UC-1: 基础渲染

  1. 组件渲染默认状态
  2. 关键区域可见
  3. 无异常

9. 状态不变性测试 (State Invariants)

  • 同一参数重复设置不应触发非必要 UI 改变
  • 与表单字段无关的操作不应影响字段值

10. 测试检查点

  • 条件 !string.IsNullOrEmpty(HeaderText 下渲染正确
  • 条件 Footer != null 下渲染正确

11. Fluent UI 对齐

对应 Fluent UI Blazor 组件:FluentDialog(Panel 模式) 源码:src/Core/Components/Dialog/FluentDialog.razor.cs、src/Core/Components/Dialog/Parameters/DialogParameters.cs 对齐要点:

  • Drawer 可对齐到 DialogType.Panel 的侧边面板语义(默认宽度 340px)。
  • Hidden/HiddenChanged 管理显示状态,Modal/PreventScroll/TrapFocus 控制遮罩与焦点。
  • 通过参数 Alignment(Left/Right/Center)与 Width/Height 控制位置与尺寸。 关键参数/事件:
  • HiddenModalPreventScrollTrapFocusAlignmentWidthHeight。 差异与扩展:
  • SxDrawer 若独立于 DialogService,也需保持同等的可访问性与遮罩语义。

12. 参考文档摘要

  • docs/ComponentInventory.md: NextUI 组件全量版图审计 (Fluent UI v4.13.2 对齐) 本文档作为 NextUI 设计系统的“全量施工蓝图”,实时对齐 Microsoft Fluent UI Blazor v4.13.2 官方组件库。所有组件分为已实现 [x]、开发中 [-] 和待开发 [ ] 状态。
  • docs/ComponentAPIGuide.md: Next UI Component API Guide (Standard Interface) 本指南定义了 Next UI 组件的标准接口。我们的目标是 API 兼容优先,确保与 Microsoft Fluent UI Blazor 库的命名习惯对齐。
  • docs/CODE_QUALITY_IMPROVEMENT_PROGRESS.md: 代码质量改进进度 > 创建日期: 2026-01-13

13. 规范合规检查

  • 可能存在硬编码样式: 存在 px 硬编码

14. 变更历史

  • 2026-02-04: 深度分析填充规范。