iter(g288): 文档步骤下限提到 4 条

This commit is contained in:
HIsheR
2026-10-26 23:18:19 +08:00
parent e109a9aa50
commit 003dae302c
5 changed files with 25 additions and 13 deletions
+5 -1
View File
@@ -1,6 +1,6 @@
# @ui-arch 组件库 Agent 文档(无图形版)
> 自动生成于 2026-10-26T15:17:13.022Z,数据源:各包 ua.manifest.json,勿手改。人类版文档站:apps/docs/index.html。
> 自动生成于 2026-10-26T15:18:04.340Z,数据源:各包 ua.manifest.json,勿手改。人类版文档站:apps/docs/index.html。
> 组件 = 普通函数,传 props 返回 DOM;状态用 signal 双向绑定:读 signal() 写 signal(v)。
## 快速上手
@@ -471,6 +471,7 @@ badge({ label: '成功', variant: 'success' })
1. 纯状态文案直接传 label,配 variant 定语义色
2. 要显示数量传 count(如未读数),超过 max(缺省 99)自动渲染成 99+
3. 只提示「有更新」用 dot: true,配合 label 给出读屏名(如「有未读消息」)
4. 不要给 badge 挂点击:它不是按钮(无 tabindex 也无键盘响应);「点角标进消息中心」应当把 badge 塞进 button 里,让按钮承担语义
现场演示:apps/docs/demo.html#sec-feedback
@@ -833,6 +834,7 @@ divider({ label: '更多信息' }) / divider({ vertical: true })
1. 在区块之间插入 divider 划分内容层次
2. 传 label 在水平线上显示居中文案,如「更多信息」
3. 工具栏内用 vertical: true 的行内竖线,dashed: true 切虚线弱化分隔感
4. 分割线是纯视觉件:没有 role 也没有焦点,读屏不会播报它。真要让读屏理解分组,用 heading 或 section,别指望横线
现场演示:apps/docs/demo.html#sec-divider
@@ -2127,6 +2129,7 @@ kbd({ keys: 'Esc' })、kbd({ keys: ['Ctrl', 'K'] })
1. 传字符串展示单键帽:kbd({ keys: "Esc" }),适合文档里说明单个按键
2. 传数组展示组合键:kbd({ keys: ["Ctrl", "K"] }),键帽之间以弱化的 + 连接(+ 对读屏隐藏)
3. 常与提示文案混排:行内 baseline 对齐,键帽底边加厚一线出立体感
4. 组件只画键帽,不做平台映射:Ctrl 与 ⌘ 的替换由调用方按平台判断后传进来(写死 Ctrl 在 Mac 上就是错的)
现场演示:apps/docs/demo.html#sec-kbd
@@ -2148,6 +2151,7 @@ highlight({ text: 'Alpha Beta', keyword: 'beta' })
1. 传 text + keyword 即可,命中片段以淡黄 mark 底展示,适合搜索结果 / 补全列表的匹配说明
2. 两个入参都接受信号:搜索框输入实时联动高亮,无需手动重渲染
3. 大小写不敏感且全部命中(非只第一处);关键词两侧空白自动忽略
4. keyword 为空或纯空白时原样返回文本,既不抛错也不全高亮:搜索框清空那一刻不用特判
现场演示:apps/docs/demo.html#sec-highlight