CNWei/stash-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: README 组件清单补全并更正数量

Browse Source 
- 组件表补上 Brand / Ticker / SearchField / EntryRow / EntryTile（此前只写进了 COMPONENTS.md）
- 组件总数 37 -> 51，与 src/components 下的 .tsx 数量一致
- SKILL.md 的 description 同步改为 51 个组件
This commit is contained in:
CNWei
2026-11-01 22:42:05 +08:00
parent 5eb1506650
commit ba41cdf52e
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -1
View File
@@ -77,7 +77,7 @@ stash-ui/
│ │ ├── icons.ts # 446 个图标名（自动生成） │ │ ├── icons.ts # 446 个图标名（自动生成）
│ │ ├── iconfont.css # 图标字体与字形（自动生成） │ │ ├── iconfont.css # 图标字体与字形（自动生成）
│ │ └── assets/iconfont.woff2 │ │ └── assets/iconfont.woff2
│ └── components/ # 37 个组件，每个 = Xxx.tsx + Xxx.module.css（见下方清单） │ └── components/ # 51 个组件，每个 = Xxx.tsx + Xxx.module.css（见下方清单）
├── site/ # 展示站（不参与库构建） ├── site/ # 展示站（不参与库构建）
│ ├── index.html / demo.html # 文档站 / 整页示例 │ ├── index.html / demo.html # 文档站 / 整页示例
│ ├── App.tsx # 左侧目录 + 右侧示例 │ ├── App.tsx # 左侧目录 + 右侧示例
@@ -97,6 +97,11 @@ stash-ui/
| `IconButton` | 圆形图标按钮（28/36/44） | `label`(必填) `icon` `variant` `size` `spinning` | | `IconButton` | 圆形图标按钮（28/36/44） | `label`(必填) `icon` `variant` `size` `spinning` |
| `TextButton` | 文字按钮（行内操作，无外框） | `icon` `tone` `disabled` `title` `label` | | `TextButton` | 文字按钮（行内操作，无外框） | `icon` `tone` `disabled` `title` `label` |
| `Card` | 白色容器（极浅描边） | `as` `padding` `hoverable` | | `Card` | 白色容器（极浅描边） | `as` `padding` `hoverable` |
| `EntryRow` | 条目行（头像 + 标题 + 描述，整行可点） | `title` `description` `href` `avatar` `badge` `onOpen` |
| `EntryTile` | 条目磁贴（上图下文白卡） | `title` `description` `cover` `ratio` `onOpen` |
| `Brand` | 站点品牌（logo / 首字标记 + 名称） | `name` `mark` `logo` `href` |
| `Ticker` | 无限滚动信息条 | `speed` `gap` `paused` `label` |
| `SearchField` | 语义版搜索框 | `value` `onChange` `variant` `hotkey` `inputRef` |
| `Cover` | 比例封面卡（2:3 / 4:3 / 16:9） | `ratio` `src` `caption` `lift` `onClick` | | `Cover` | 比例封面卡（2:3 / 4:3 / 16:9） | `ratio` `src` `caption` `lift` `onClick` |
| `Image` | 带比例 / 圆角 / 失败降级的图片 | `ratio` `fit` `radius` `fallback` | | `Image` | 带比例 / 圆角 / 失败降级的图片 | `ratio` `fit` `radius` `fallback` |
| `FormField` | 表单字段排版（标签 + 提示 / 错误） | `label` `hint` `error` `required` | | `FormField` | 表单字段排版（标签 + 提示 / 错误） | `label` `hint` `error` `required` |
skills/stash-ui/SKILL.md
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: stash-ui name: stash-ui
description: Use, extend, or restyle the Stash UI component library (@stash/ui): a zero-dependency React design system with tokens, 37 components, an in-repo docs site and a full-page demo. Load before writing or changing any component, or before composing pages with @stash/ui. description: Use, extend, or restyle the Stash UI component library (@stash/ui): a zero-dependency React design system with tokens, 51 components, an in-repo docs site and a full-page demo. Load before writing or changing any component, or before composing pages with @stash/ui.
--- ---
# Stash UI # Stash UI