book-index-ui 0.65.3 → 0.66.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -1
- package/dist/book-index-ui.css +10 -0
- package/dist/index.cjs +94 -89
- package/dist/index.d.ts +126 -2
- package/dist/index.js +6898 -7071
- package/dist/storage-entry-Bw_cAsLM.cjs +2 -0
- package/dist/{storage-entry-DuObqdka.js → storage-entry-D9rs8i1m.js} +965 -630
- package/dist/storage.cjs +1 -1
- package/dist/storage.d.ts +236 -0
- package/dist/storage.js +17 -11
- package/dist/themes.css +41 -0
- package/dist/tokens.css +359 -0
- package/package.json +4 -2
- package/dist/storage-entry-h5vhXs0r.cjs +0 -2
package/README.md
CHANGED
|
@@ -14,9 +14,34 @@ npm install book-index-ui
|
|
|
14
14
|
```ts
|
|
15
15
|
import { ... } from 'book-index-ui' // React 组件 + 类型 + 数据层
|
|
16
16
|
import { ... } from 'book-index-ui/storage' // 仅数据层(无 React,体积小,适合 Node/Worker)
|
|
17
|
-
import 'book-index-ui/
|
|
17
|
+
import 'book-index-ui/tokens.css' // 设计变量(推荐;用到组件时引入)
|
|
18
|
+
import 'book-index-ui/themes.css' // 可选:内置主题 indigo / ink(<html data-theme>)
|
|
19
|
+
import 'book-index-ui/styles' // 旧入口=tokens.css + themes.css 合并,保留兼容
|
|
18
20
|
```
|
|
19
21
|
|
|
22
|
+
## 样式契约(设计变量)
|
|
23
|
+
|
|
24
|
+
`tokens.css` 是设计变量的**唯一真源**(由 `src/styles/tokens.ts` 生成)。宿主的做法:
|
|
25
|
+
|
|
26
|
+
1. 先 `import 'book-index-ui/tokens.css'`;
|
|
27
|
+
2. 再在自己的 `:root` 里**只覆盖品牌相关的变量**(朱色一族、字体、页面底色等);覆盖声明须在 tokens.css 之后加载;
|
|
28
|
+
3. 不要重写整套 `--bim-*`,也不要写 `.bim-*` 结构选择器去改组件内部——要调的东西都应该有变量,没有就提需求加变量。
|
|
29
|
+
|
|
30
|
+
内置主题(indigo、ink)在 `themes.css`,用 `<html data-theme="…">` 切换;宿主自己用品牌色接管的,不必引。版式(`data-layout="boxed"`,界栏)在 tokens.css 里。
|
|
31
|
+
|
|
32
|
+
**对外承诺的变量**:`tokens.css` 里声明的全部 `--bim-*`(含 `data-layout="boxed"` 块里改的那些),改名或删除都按破坏性改动处理,需升 minor 并写进变更说明。常用分组:
|
|
33
|
+
|
|
34
|
+
| 分组 | 变量(节选) |
|
|
35
|
+
|---|---|
|
|
36
|
+
| 颜色 | `--bim-bg` `--bim-fg` `--bim-page-bg` `--bim-ink` `--bim-accent` `--bim-accent-deep` `--bim-link` `--bim-muted` `--bim-border` `--bim-flag-bg` … |
|
|
37
|
+
| 字体 | `--bim-font-ui` `--bim-font-body` `--bim-font-serif` `--bim-font-reading` |
|
|
38
|
+
| 阅读器字体 | `--bim-font-reader-ui` `--bim-font-reader-serif` `--bim-font-reader-reading`:只在阅读器根节点(`.bim-rd`)内换掉对应字体;默认等于上面的全局字体 |
|
|
39
|
+
| 列表页 | `--bim-browser-pad-x`:列表页(IndexBrowser)标题栏、检索框行、结果区的左右内边距,默认 `20px`,宿主要贴齐版心时设 `0` |
|
|
40
|
+
| 版式 | `--bim-fr-*`(疏朗/界栏) |
|
|
41
|
+
| 阅读器 | `--bim-reader-top`(吸顶工具条让出的顶部高度)等 |
|
|
42
|
+
|
|
43
|
+
完整清单见 `src/styles/tokens.ts`。`tests/unit/tokens.test.ts` 保证 tokens.css 与源文件同步、组件里没有颜色字面量。
|
|
44
|
+
|
|
20
45
|
## 主要 export
|
|
21
46
|
|
|
22
47
|
### React 组件
|
package/dist/book-index-ui.css
CHANGED
|
@@ -312,6 +312,16 @@
|
|
|
312
312
|
--bim-font-serif: "Songti SC", "Songti TC", STSong, "Noto Serif CJK SC", "Source Han Serif SC", SimSun, serif;
|
|
313
313
|
/* 阅读器正文(整理本 / 全文);默认接 font-serif,只需覆盖那一个就同时换掉 */
|
|
314
314
|
--bim-font-reading: var(--bim-font-serif);
|
|
315
|
+
/* 阅读器范围(.bim-rd)内的界面字体:阅读器根节点上把 font-ui / font-body 换成它;宿主想让阅读器单独用系统字体栈,覆盖这一个即可 */
|
|
316
|
+
--bim-font-reader-ui: var(--bim-font-ui);
|
|
317
|
+
/* 阅读器范围内的宋体:阅读器根节点上把 font-serif 换成它 */
|
|
318
|
+
--bim-font-reader-serif: var(--bim-font-serif);
|
|
319
|
+
/* 阅读器范围内的正文字体:阅读器根节点上把 font-reading 换成它 */
|
|
320
|
+
--bim-font-reader-reading: var(--bim-font-reading);
|
|
321
|
+
|
|
322
|
+
/* ==== 列表页(IndexBrowser) ==== */
|
|
323
|
+
/* 列表页标题栏、检索框行、统计摘要、结果区的左右内边距;宿主要贴齐自己的版心时设 0 */
|
|
324
|
+
--bim-browser-pad-x: 20px;
|
|
315
325
|
}
|
|
316
326
|
|
|
317
327
|
/* ==== 主题:indigo(<html data-theme="indigo">)==== */
|