CommandPaletteFooter 组件契约¶
契约概览¶
| 区域 | 契约 |
|---|---|
| 公开契约 | CommandPaletteFooter,支持可选的 children、ref、xstyle、className、style 以及根 DOM props。 |
| 行为 | 底部一行键盘指引:默认显示带翻译标签的导航、选择和关闭快捷键;children 会替换它们。 |
| 最终用户影响 | 用户可以看清哪些按键用于移动、运行和关闭面板。 |
| 构建者影响 | 无。 |
| 兼容性/就绪状态 | 记录已发布行为;无公开变更。 |
| 审查检查 | 拒绝接受自带 role 或 name 的 footer、丢失默认快捷键的 footer,或无法换行的指引。 |
| 治理规则 | component:Kbd;architecture:public-component-api;architecture:component-theming-surface。 |
此表是审查预判;下文正文具有权威性。
意图¶
CommandPaletteFooter 是 CommandPalette 底部的指引行。消费者用法见 CommandPaletteFooter.doc.mjs。
兼容性与迁移¶
- 已发布的默认行为保留:
yes - 兼容性类别:记录已发布行为;无公开变更
- 受控/非受控行为:不适用
- 迁移决策:无
消费者迁移说明属于消费者文档和发布说明。
所有权边界¶
拥有
- footer 根元素、其布局、辅助文本样式以及
command-palette-footer目标(FR1, FR3)。 - 默认指引以及由
children替换默认指引(FR2)。 - 根 ref、DOM props 和样式(FR4)。
不拥有 / 非目标
- 绘制每个快捷键——由
component:Kbd拥有。 - 指引所描述的键盘行为——由
component:CommandPalette拥有。
公开概念¶
除消费者 props 外,没有组件本地概念。
行为与布局契约¶
| ID | 不变式 | 依据 |
|---|---|---|
| FR1 | 根元素是使用次要颜色的辅助文本换行行,自身不带有 role 或 name。 | 当前源码和测试 |
| FR2 | 在没有 children 时,根元素按顺序显示三条提示:Up 和 Down 带翻译后的导航标签,Enter 带选择,Escape 带关闭,每个快捷键都是一个 Kbd。children 会替换这三者。 |
当前源码和测试 |
| FR3 | 根元素带有 command-palette-footer 目标。 |
当前源码和测试 |
| FR4 | ref、DOM props、className、style 和 xstyle 都会作用到根元素,调用者的 class 位于生成的 class 之后。 |
当前源码和测试 |
允许的变体¶
- AV1 — 指引。 调用者可以替换默认提示。
- AV2 — 翻译。 标签文本跟随当前区域设置。
代表性状态¶
| 状态 | 必需不变式 | 允许的变体 |
|---|---|---|
| 默认 | 导航、选择和关闭提示按顺序显示。 | 区域设置。 |
| 自定义 | children 替换默认内容。 |
内容。 |
| 窄表面 | 提示会换行成更多行。 | 行数。 |
转换与优先级顺序¶
- ORD1 — 内容。 如果提供了
children则使用children,否则使用默认提示。
性能与资源¶
- 无资源规则。
无障碍契约¶
- AR1 — 不拥有语义。 footer 不添加 role、name 或焦点目标;每个快捷键的语义由 Kbd 负责。
设计关系¶
| 解剖部位或状态 | 设计要求 | 表示权威 | 层级角色 | 组件契约 |
|---|---|---|---|---|
| 底部 | 一个可换行的辅助指引行。 | 当前源码 | 辅助 | FR1, FR3 |
| 键盘快捷键 | 显示一个快捷键。 | component:Kbd |
辅助 | FR2 |
由 component:CommandPalette 拥有的 CommandPalette 整体解剖图,将底部和键盘快捷键部分映射在其中。
家族与系统关系¶
component:Kbd负责快捷键的绘制和语义。component:CommandPalette负责指引所命名的键盘行为。
验证映射¶
| 契约 | 验证 | 代表性状态 | 变更或失败预期 | 审计章节 |
|---|---|---|---|---|
| -------- | --------------------------------------------------------------------------------------- | --------------------- | -------------------------------------------------- | --------------------------------------- |
| FR1, AR1 | CommandPaletteFooter.test.tsx 包裹测试;CommandPaletteFooter.a11y.chromium.spec.ts |
窄屏;LTR 和 RTL | 根节点上存在角色或名称,或缺少包裹,则失败。 | audit:CommandPaletteFooter/layout |
| FR2 | CommandPaletteFooter.test.tsx 默认标签与自定义子元素测试 |
默认;自定义 | 提示丢失或子元素被忽略则失败。 | audit:CommandPaletteFooter/behavior |
| FR3 | CommandPaletteFooter.test.tsx "在其单一根节点上承载稳定的主题目标" |
任意 | 缺少目标则失败。 | audit:CommandPaletteFooter/theming |
| FR4 | CommandPaletteFooter.test.tsx className、xstyle、style、ref 和 DOM 属性测试 |
根输入 | 任一输入被丢弃则失败。 | audit:CommandPaletteFooter/public-api |
从源代码读取,目前尚无针对性测试:
- FR1:辅助类型和次要颜色。
决策日志¶
未记录任何组件局部的决策。
未决问题¶
无。
内容边界¶
本文件不重复消费者属性表或示例,也不重复 CommandPalette 的搜索与键盘行为。它链接到这些内容的所属文档。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 as/astryx