InputGroupText 组件契约¶
契约一览¶
| 领域 | 契约 |
|---|---|
| 公共契约 | 无更改。InputGroupText 接受 children 和基础 props。 |
| 行为 | InputGroup 内部的一个非交互、弱化样式文本或图标单元格,与相邻元素的边框相接,并且仅圆角化该组的外角。 |
| 最终用户影响 | 用户会看到固定的前缀或后缀(如 $ 或 https://)作为字段的一部分。它作为纯文本被读取,而不是作为控件。 |
| 构建者影响 | 无。 |
| 兼容性/就绪状态 | 记录了已交付的行为;没有 API 或默认值更改。不含从右到左字母的纯文本位于内层 span 中,带有 dir="ltr",并且该单元格隔离其文本。 |
| 审查检查 | 拒绝在单元格上设置交互角色或 Tab 停靠点、文本换行或缩小、或内部圆角。 |
| 治理规则 | component:InputGroup;architecture:component-theming-surface。 |
此表是审查投影;以下正文具有权威性。
意图¶
InputGroupText 是 InputGroup 的文本附加物:显示在输入框之前或之后的一段固定文本或一个图标。消费者用法位于 InputGroupText.doc.mjs 中。
兼容性与迁移¶
- 已发布的默认值保留:
yes - 兼容性类别:没有公共 prop、默认值或导出更改。DOM 变化:不含从右到左字母的纯文本位于内层
span中,带有dir="ltr",并且该单元格隔离其文本(unicode-bidi: isolate) - 受控/非受控行为:不适用
- 迁移决策:无
消费者迁移说明属于消费者文档和发布说明。
所有权边界¶
拥有
- 文本单元格的绘制、尺寸、边框连接和外角圆角。
input-group-text目标。
不拥有 / 非目标
- 组标签、行高和描述——由
component:InputGroup拥有。 - 为输入框命名或提供描述——该单元格不会被输入框的名称或描述引用。
- 在 InputGroup 之外使用——无契约。
公共概念¶
没有新的公共概念。内容为调用方提供的文本或图标。
行为与布局契约¶
| ID | 不变量 | 依据 |
|---|---|---|
| FR1 | InputGroupText 渲染一个无 role 的非交互元素,持有 children;不含从右到左字母的纯文本位于内层 span 中,带有 dir="ltr"(design:bidirectionality DR2)。ref、className、style、xstyle 和其他 DOM props 到达外层元素。 |
当前源代码和测试 |
| FR2 | 该单元格在垂直方向居中内容,并带有较小的内联内边距;在弱化背景上使用次要文本颜色的正文文本;永不换行,也永不缩小。 | 当前源代码 |
| FR3 | 该单元格绘制一条强调的、宽度为一个边框的边框。第一个之后的每个单元格都与其前导邻居重叠一个边框宽度。只有第一个子元素的前导外角和最后一个子元素的尾随外角使用元素半径进行圆角化。 | 当前源代码 |
| FR4 | 该单元格具有 astryx-input-group-text。 |
architecture:component-theming-surface;当前源代码 |
允许的变体¶
- AV1 — 内容。 任何文本或图标。单元格仅读取纯文本以选择其方向(FR1);富内容被隔离,调用方标记其方向。
- AV2 — 主题绘制。 主题可以通过
input-group-text重新设置该单元格的样式。
代表性状态¶
| 状态 | 必需不变量 | 允许的变体 |
|---|---|---|
| 前缀 | 前导外角圆角;尾随边缘为直角。 | 内容。 |
| 后缀 | 尾随外角圆角;与输入框的边框重叠。 | 内容。 |
转换与优先级顺序¶
- ORD1 — 样式。 组件样式,然后是
xstyle,接着是className和style。
性能与资源¶
- PR1 — 静态。 没有状态、效果或监听器。
无障碍契约¶
- AR1 — 纯文本。 该单元格没有角色或 Tab 停止点,并按阅读顺序作为普通文本被读取。
设计关系¶
| 结构或状态 | 设计要求 | 表示权威 | 层级角色 | 组件契约 |
|---|---|---|---|---|
| 文本单元格 | 弱化、带边框、次要文本的单元格,并连接到所在行。 | 当前来源 | 辅助 | FR2, FR3 |
没有设计记录管辖 InputGroupText。
家族与系统关系¶
component:InputGroup承载该单元格,并拥有其所连接的行。
验证映射¶
| 契约 | 验证 | 代表性状态 | 变更或失败预期 | 审计章节 |
|---|---|---|---|---|
| FR1 | InputGroupText.test.tsx 中的“是纯文本,没有角色且没有 Tab 停止点(FR1, AR1)”以及“将 ref、DOM props、className 和 style 传递给单元格,单元格承载其目标(FR1, FR4)”;InputGroup.test.tsx 中的 addon 以及前缀/后缀用例 |
前缀和后缀文本;一个 ref、一个 DOM prop、className 和 style |
如果存在角色、Tab 停止点、缺少 addon 文本,或某个 prop 未到达单元格,则失败。 | audit:InputGroupText/anatomy |
| FR2 | InputGroupText.test.tsx 中的“保持其内容在一行内、不收缩且沿交叉轴居中(FR2)”;InputGroupTextAudit.a11y.chromium.spec.ts 绘制检查 |
前缀、后缀以及两者;小号和大号;窄视口;浅色、深色与 Butter | 换行、收缩、内容偏离中心,或 padding、文本颜色、字体大小或背景不同于 token 均失败。证据缺口:没有检查断言正文字体族或行高。 | audit:InputGroupText/layout |
| FR3 | InputGroupTextAudit.a11y.chromium.spec.ts 边框、连接和圆角检查 |
文本输入框周围的前缀和后缀;LTR 和 RTL | 边框颜色或宽度不同于 token、边框样式不是 solid、重叠量不是一条边框宽度,或内部圆角错误,均失败。 |
audit:InputGroupText/layout |
| FR4 | InputGroupText.test.tsx 中的“将 ref、DOM props、className 和 style 传递给单元格,单元格承载其目标(FR1, FR4)”;InputGroupTextAudit.a11y.chromium.spec.ts class 检查 |
每个单元格 | 没有 astryx-input-group-text 的单元格失败。 |
audit:InputGroupText/anatomy |
| ORD1 | InputGroupText.test.tsx 中的“调用方 xstyle 在其自身样式之后应用(ORD1)”;mergeProps.test.ts 中的“将字符串第三个参数视为追加的 className”和“将第四个参数作为覆盖样式应用” |
覆盖单元格样式的调用方 xstyle、className 和 style |
如果单元格样式胜过调用方 xstyle、调用方 className 替代了单元格类而不是追加,或调用方 style 未覆盖样式,则失败。 |
audit:InputGroupText/anatomy |
| RTL 关系 | RTL 审计在 InputGroup / With prefix 上的精选 D2 目标(apps/storybook/rtl-audit/targets.json);InputGroupTextAudit.a11y.chromium.spec.ts 在 InputGroup / With prefix and suffix 上的 RTL 用例 |
文本输入框前的文本前缀,以及文本输入框周围的前缀和后缀;LTR 和 RTL | 不在其输入的内联起始位置的前缀将不满足 D2。在审计中,未遵循行方向的单元格或在错误一侧重叠的单元格均失败。 | audit:InputGroupText/i18n-rtl |
design:bidirectionality DR2 |
MixedDirectionText.a11y.chromium.spec.ts |
在 RTL 和 LTR 下的 https://、.com、+3、@alice、iPhone جديد 和 example.com موقع(Mixed Direction story) |
addon 文本中的弱字符或中性字符在 RTL 下重排(//:https、com.、3+、alice@),或带有前导拉丁单词的从右到左文本从左到右排列,则每个字符的渲染位置都会失败。 |
audit:InputGroupText/i18n-rtl |
决策日志¶
无组件级决策。
未决问题¶
无。
内容边界¶
本文件不重复使用方 prop 表/示例、当前审计结果、实现步骤或家族/系统规则,而是链接到它们的所有者。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 as/astryx