@zero-library/common 2.3.12 → 2.4.0

package/README.md

@@ -0,0 +1,43 @@
+# @zero-library/common
+
+通用组件、Hooks 与工具函数集合包。用于在业务项目与其它组件库（如 chat-agent）中复用基础能力。
+
+该文档只维护稳定信息（安装、入口、模块边界、开发方式）。所有具体 API 以源码类型与注释为准，避免重复维护导致漂移。
+
+## 安装
+
+```bash
+pnpm add @zero-library/common
+```
+
+样式（建议在应用入口引入一次）：
+
+```ts
+import '@zero-library/common/style'
+```
+
+## 导出结构
+
+包入口：[src/index.ts](file:///c:/work/lgbh/zero-library/packages/common/src/index.ts)
+
+- components：UI 组件集合（文件预览、Markdown 编辑、渲染控制等）
+- hooks：通用 hooks（WebSocket、iframe bridge、valtio context 等）
+- utils：工具函数与基础能力（request/storage/is/date 等）
+
+## 开发
+
+```bash
+pnpm --filter=common run build
+pnpm --filter=common run dev
+```
+
+目录结构：
+
+- src/components：组件集合与入口导出
+- src/hooks：hooks 集合与入口导出
+- src/utils：工具函数与基础能力
+
+注意事项：
+
+- 样式需显式引入 `@zero-library/common/style`
+- 目前以单入口聚合导出为主；如需更细粒度按需分发，可在构建与 exports 层做进一步拆分（结构性改造）