跳转至

LayerProvider 组件契约

契约概览

领域 契约
公共契约 LayerProvider 接受 children、toast({position, maxVisible, inset})和 inset({blockStart, blockEnd, inlineStart, inlineEnd})。
行为 最外层提供者提供层配置,并在 Toast 被导入后渲染唯一的 toast 视口。嵌套提供者原样渲染其 children,唯一的例外是嵌套的 inset 会收窄其子树中层的 inset。
对最终用户的影响 Toast 会出现在配置好的一个角落,锚定层和 Toast 会避开声明的浮动条。
对构建者的影响 无。
兼容性/就绪状态 记录已交付行为,唯一的例外是 toast 视口会等待 Toast 导入(FR1);无公开变更。
评审检查 拒绝来自嵌套提供者的第二个 toast 视口、托管与触发器关联的层的提供者,或渲染层的方式与无提供者时不同的默认提供者。
治理规则 spec:AST-059 FR6(inset);architecture:layer-runtime INV10–INV11;component:Toast。

此表是评审投影;以下正文具有权威性。

意图

LayerProvider 是 Astryx 层的应用级配置点。它是 Layer.doc.mjs 以行内条目形式记录的唯一公共组件;该文档的其余部分描述层运行时,而层运行时归 architecture:layer-runtime 所有。本记录定义该提供者自身渲染的内容。

兼容性与迁移

  • 已发布的默认行为保留:yes
  • 兼容性类别:记录已交付行为,唯一的例外是 toast 视口会等待 Toast 导入(FR1);无公开变更
  • 受控/非受控行为:不适用
  • 迁移决策:无

使用方迁移说明应写入使用方文档和发布说明。

所有权边界

拥有

  • 提供者是否挂载 toast 视口,以及嵌套提供者透传的内容(FR1–FR3)。

不拥有 / 非目标

  • inset 对 gutter(间距)、cap(上限)和 toast 视口的作用——归 spec:AST-059 FR6 所有。
  • 层的承载、放置和文本默认值——归 architecture:layer-runtime 和 spec:AST-038 所有。
  • Toast 行为,包括 toast.inset 的各条边如何与 inset 组合——归 component:Toast(FR6)所有。

公共概念

除消费者 props 外,没有组件本地概念。

行为与布局契约

ID 不变量 依据
FR1 一个上方没有 LayerProvider 的提供者提供层上下文(toast 配置和 inset)以及 toast 上下文。一旦 Toast 被导入,它会在 children 之后渲染一个 toast 视口,该视口由 toast.position、toast.maxVisible、toast.inset 和 inset 配置;在此之前,不渲染任何视口。 当前源码与测试
FR2 嵌套在另一提供者之下的提供者不会挂载 toast 视口。没有 inset 时,它原样渲染其 children;有 inset 时,它声明的每条边适用于其子树中的层,并保留外层 toast 配置。至于它未设置的边在该子树中读取到什么,本契约不在此约定。 当前源码;spec:AST-059 FR6
FR3 当未声明任何内容时,提供者不会改变任何层的几何属性,因此默认提供者下的层与没有提供者时的层一致。 spec:AST-059 FR6;测试

允许的变体

  • AV1 — 配置。 toast 和 inset 的值可变。

典型状态

状态 必需不变量 允许的变体
根提供者 提供上下文;Toast 加载后出现一个视口。 Toast 配置。
无 inset 的嵌套提供者 children 不变;无第二个视口。 —
带 inset 的嵌套 子树 inset 收窄;toast 配置不变。 Inset。

转换与优先级顺序

  • ORD1 — Inset。 对于嵌套 provider 声明的边,其值在其子树中生效;未设置的边不被收缩(FR2)。

性能与资源

  • 无资源规则。

无障碍契约

  • 没有自身的无障碍行为;toast 视口的无障碍行为由 component:Toast 负责。

设计关系

结构或状态 设计需求 表现权威 层级角色 组件契约
Provider 自身不渲染任何视觉表面。 当前来源 辅助 FR1

Layer.doc.mjs 未声明任何结构,因此不记录任何结构主题映射。

家族与系统关系

  • spec:AST-059 FR6 负责定义 inset 的含义。
  • architecture:layer-runtime INV10 指出 provider 是配置,而非通用 layer 宿主。

验证映射

契约 验证 代表性状态 变更或失败预期 审计部分
FR1–FR3 LayerProvider.test.tsx;FR1 还参见 toastHost.test.tsx 和 toastHost.lateRegistration.test.tsx;LayerProvider.test.tsx 的 toast 配置套件,用于 toast.maxVisible 以及不带 inset 的嵌套 provider(一个视口,保留外部配置,不添加额外元素) 默认、已声明 inset、嵌套、toast inset、无 Toast 导入 默认 provider 差异、未到达其 layer 的 inset,或没有 Toast 导入的视口,均失败。 audit:LayerProvider/behavior

从源码读取,尚无聚焦测试:

  • FR1:toast.position 到达视口。

决策日志

  • 未记录任何组件局部决策。

开放问题

  • 无。

内容边界

  • 本文件不重复消费者 prop 表、inset 规则或 layer 运行时;它链接到其所有者。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 as/astryx