14 KiB
FloatButton 语义结构
生成产物:由源文档生成,不要手工编辑。修改内容请回到控件文档、源码 public surface、Token 类型或生成数据、Gallery ShowCase 或源码结构。
Semantic Parts
| Part | AtomUI 节点 | 职责 | 相关 API | 相关 Token | 稳定性 |
|---|---|---|---|---|---|
root |
FloatButton |
控件根语义区域,承载 public API、状态归一、主题入口和 Gallery 可观察行为。 | 见 API 与契约模型 | 见视觉与主题模型 | stable |
content |
内容区域 |
承载用户内容、图标、文本或装饰性展示。 | 见 API 与契约模型 | 见视觉与主题模型 | stable |
command |
真实 FloatButton |
承载 Command、CommandParameter、CanExecute、点击和禁用语义;host 只做投影。 |
Command、CommandParameter、Href |
见视觉与主题模型 | stable |
state |
状态区域 |
表达 hover、pressed、disabled、loading、selected 或控件专属状态。 | 见 API 与契约模型 | 见视觉与主题模型 | stable |
theme |
主题区域 |
连接 ControlTheme、SharedToken、控件 Token 和资源键。 | 见 API 与契约模型 | 见视觉与主题模型 | stable |
Abstract AXAML Structure
未定位到可生成抽象 AXAML 结构的 ControlTheme 模板。生成器不会根据 semantic parts 发明 AXAML 节点;请以 Template Parts、主题文件和源码索引为准。
Composition Model
该章节由控件 Themes/ 文件夹中的真实主题文件生成,用于说明 public 控件与内部协作对象之间的运行时结构。内部节点只用于理解和维护,不应指导用户代码直接依赖。
控件角色图
FloatButton
-> BackTopFloatButtonHost (control theme, BackTopFloatButtonHostTheme.axaml)
-> FloatButtonGroupHost (control theme, FloatButtonGroupHostTheme.axaml)
-> FloatButtonGroup (control theme, FloatButtonGroupTheme.axaml)
-> FloatButtonItemsControl#ItemsControl (internal-observable)
-> Border (template-stable)
-> Canvas (template-stable)
-> FloatButton#Trigger (public)
-> MotionActor#{x:Static atom:BaseMotionActor.MotionActorPart} (internal-observable)
-> FloatButtonItemsControl#ItemsControl (internal-observable)
-> FloatButtonHost (control theme, FloatButtonHostTheme.axaml)
-> FloatButtonItemsControl (control theme, FloatButtonItemsControlTheme.axaml)
-> Border#Frame (template-stable)
-> DockPanel#RootLayout (template-stable)
-> Control#EmptyControl (template-stable)
-> Border#ContentFrame (template-stable)
-> Panel (template-stable)
-> FloatButtonSeparatorLayer (template-stable)
-> StackPanel#PART_ItemsLayout (template-stable)
-> Border#ContentFrame (template-stable)
-> Panel (template-stable)
-> FloatButtonSeparatorLayer (template-stable)
-> StackPanel#PART_ItemsLayout (template-stable)
-> FloatButton (control theme, FloatButtonTheme.axaml)
协作节点
| 节点 | 类型 | 来源 | 生命周期 owner | 影响的 public API | 稳定性 | Agent 使用边界 |
|---|---|---|---|---|---|---|
FloatButton |
public control | 源文档 + public API |
用户代码 / 控件宿主 | public API | public | 用户可直接使用 public 控件;可作为示例和 API 入口。 |
BackTopFloatButtonHost |
control theme | BackTopFloatButtonHostTheme.axaml |
FloatButton | 主题状态 / visual state | internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
FloatButtonGroupHost |
control theme | FloatButtonGroupHostTheme.axaml |
FloatButton | 主题状态 / visual state | internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
FloatButtonGroup |
control theme | FloatButtonGroupTheme.axaml |
用户代码 / 控件宿主 | Background, BoxShadow, ButtonType, Icon, MenuPlacement, Shape |
public | 用户可直接使用 public 控件;可作为示例和 API 入口。 |
ItemsControl |
template node (FloatButtonItemsControl) | FloatButtonGroupTheme.axaml |
FloatButtonGroup | BoxShadow, Shape |
internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
Trigger |
template node (FloatButton) | FloatButtonGroupTheme.axaml |
FloatButtonGroup | ButtonType, Icon, Shape |
public | 用户可直接使用 public 控件;可作为示例和 API 入口。 |
{x:Static atom:BaseMotionActor.MotionActorPart} |
template node (MotionActor) | FloatButtonGroupTheme.axaml |
FloatButtonGroup | BoxShadow, MenuPlacement, Shape |
internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
FloatButtonHost |
control theme | FloatButtonHostTheme.axaml |
FloatButton | 主题状态 / visual state | internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
FloatButtonItemsControl |
control theme | FloatButtonItemsControlTheme.axaml |
FloatButton | Background, BoxShadow, CornerRadius, Lines, Orientation |
internal-observable | 用于理解结构和状态流,不应指导用户代码直接依赖。 |
Frame |
template node (Border) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | Background, BoxShadow, CornerRadius, Lines, Orientation |
template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
RootLayout |
template node (DockPanel) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | Background, BoxShadow, CornerRadius, Lines, Orientation |
template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
EmptyControl |
template node (Control) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | 主题状态 / visual state | template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
ContentFrame |
template node (Border) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | Background, BoxShadow, CornerRadius, Lines, Orientation |
template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
Panel |
template node (Panel) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | Lines, Orientation |
template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
PART_ItemsLayout |
template node (StackPanel) | FloatButtonItemsControlTheme.axaml |
FloatButtonItemsControl | Orientation |
template-stable | 用于主题维护;变更需同步主题、实现和 LLMS。 |
FloatButton |
control theme | FloatButtonTheme.axaml |
用户代码 / 控件宿主 | 主题状态 / visual state | public | 用户可直接使用 public 控件;可作为示例和 API 入口。 |
Template Parts
| 契约组 | 代表成员 | 维护含义 |
|---|---|---|
| 内容与数据 | CloseIcon、Description、DescriptionTemplate、Icon |
定义控件展示内容、输入数据、模板或业务对象入口。 |
| 选择与集合 | BadgeCount、BadgeOverflowCount、IsTriggerMode |
维护选择、展开、过滤、分页、分组或集合状态。 |
| 命令与动作 | Command、CommandParameter、Href |
通过 Avalonia Button 命令语义触发业务动作;host 只做投影转发,不自行执行命令。 |
| 交互与状态 | IsBadgeEnabled、IsDotBadge、IsMotionEnabled、IsOpen |
表达用户可观察状态、可用性、清除、加载或反馈语义;FloatButtonGroup.IsOpen 与 FloatButtonGroupHost.IsOpen 默认双向绑定。 |
| 视觉与布局 | BadgeColor、BadgeOffset、BoxShadow、FloatOffsetX、FloatOffsetY、MenuPlacement、Orientation、Placement、SeparatorBrush、Shape 等 12 项 |
影响尺寸、位置、颜色、形状、密度和模板视觉变量。 |
| 动效与异步 | MenuMotionDuration、MotionDuration、ToTopDuration |
约束动效开关、异步加载、播放速度、超时和任务边界。 |
| 其他稳定入口 | ButtonType、Target、Tooltip、Trigger |
保留为 public surface,变更前需确认 Gallery 和用户 XAML 依赖。 |
Pseudo Classes
| 状态反馈 | public API、内部状态和伪类如何形成用户可感知反馈。 | open/close、motion、visual option。 | | 主题语义 | ControlTheme、SharedToken、控件 Token 和模板绑定如何表达视觉。 | FloatButton Token + ControlTheme。 |
State Flow
FloatButton 的状态流按以下路径收敛:
Public API / inherited command / item source / user input
-> 控件实例状态
-> effective state / pseudo-class / template property
-> ControlTheme selector / presenter / renderer
-> Gallery 可观察行为
状态维护规则:
- Disabled 或不可交互状态优先屏蔽 pointer、keyboard、motion 和提交类反馈。
Command.CanExecute=false必须通过 Avalonia Button 语义反映为不可执行状态;BackTop 场景下不可执行命令也应阻止回到顶部动作。- open/close、motion、visual option 状态由控件实例或明确的数据 owner 推导,不能在 template part 之间双向竞争。
IsOpen是默认TwoWay的受控状态;交互路径应使用 current value 语义更新,不得用样式优先级写入破坏用户绑定。- Host 创建的 overlay 按钮只能接收 host 公共属性投影;命令执行、
CanExecute、事件顺序和禁用状态仍由真实FloatButton作为交互 owner。 - Group host 搬移子按钮到 overlay group 时必须保留原有绑定语义,使未设置本地
DataContext的子项继承 host 数据上下文。 - 模板重套用时必须把 public API 对应状态回放到新的 part、伪类和主题变量。
- 集合、弹层、异步、动效或窗口相关状态必须能处理 reset、close、cancel、detach 和 owner 释放。
Theme and Token Boundaries
FloatButton 的视觉模型由控件模板、ControlTheme、SharedToken 和必要的控件 Token 共同构成。
| 主题文件 | 职责 |
|---|---|
AbstractFloatButtonTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
BackTopFloatButtonHostTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
BackTopFloatButtonTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
FloatButtonGroupHostTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
FloatButtonGroupTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
FloatButtonHostTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
FloatButtonItemsControlTheme.axaml |
定义集合项、容器项或局部单元的状态视觉。 |
FloatButtonTheme.axaml |
定义局部操作入口、按钮或 handle 的状态视觉。 |
FloatButton 使用 FloatButtonToken 作为控件 Token scope。Token 只表达组件视觉语义,不承载 open/close、motion、visual option 运行时状态。
主题维护规则:
- 不删除或重命名已经稳定的 ControlTheme key、template part、伪类和资源 key。
- 不把可由 AXAML 表达的模板状态迁移为 C# 动态创建视觉。
- 不把 hover、pressed、selected、expanded、loading、filter、popup open 等运行时状态写入 Token。
- Browser 或平台特化主题必须保持同一 API 的语义一致。
Token 边界:
FloatButton Token 只表达组件级视觉变量,例如尺寸、间距、颜色、圆角、阴影、图标尺寸和弹层边界。Token 不承载运行时选择、展开、加载、错误、上传任务、过滤条件或业务状态。
当前 Token scope:
FloatButtonToken,scope id 为FloatButton,源码位于src/AtomUI.Desktop.Controls/FloatButton/FloatButtonToken.cs。
Customization Boundaries
维护 FloatButton 时必须保持以下不变量:
- 不擅自新增、删除、重命名或改变 public/protected API、Avalonia 属性、事件和默认值。
- 不破坏 template part、伪类、ControlTheme key、Token 名称和资源 key。
- 不改变 Gallery 已展示的 XAML 用法、默认外观、交互顺序和状态优先级。
- 不手动绕过 Avalonia Button 命令机制执行
ICommand;所有命令状态必须由真实FloatButton统一承载。 - 不让 overlay 搬移破坏 group 子按钮的
DataContext继承,也不覆盖子项显式设置的本地数据上下文。 - Template part 重新应用、集合替换、弹层关闭、窗口失活和控件 detach 时必须释放旧订阅和资源宿主。
- 不通过隐藏延迟、强制刷新或吞异常掩盖状态同步问题。
- 不引入运行时反射扫描作为 API、Token 或数据路径发现机制。
- 文档只描述当前稳定设计;历史变化记录在
changelog.md。
维护不变量:
维护 FloatButton 时不得破坏:
- Public API、默认值、事件顺序和 Gallery 可观察行为。
- Template part 名称、ControlTheme key、伪类和资源 key。
- Avalonia Button 命令语义:
CanExecute、禁用状态、点击事件和命令执行顺序不得被 host 手动调用路径绕开。 - Host overlay 投影的 acquire/release 必须成对;不能留下命令绑定、数据上下文绑定或 child 逻辑父级保留。
- Group 子按钮的命令绑定必须能继承 host
DataContext,同时保留子项本地DataContext的优先级。 - 旧 template part、事件订阅、Popup/Flyout/Window host 和 collection view 的释放路径。
- Light/Dark、Browser/Desktop 和不同 SizeType 下的主题一致性。
- 控件文档、源码 public surface、Token 类型或生成数据与源码契约的一致性。