@haklex/ rich- style- token (英语)
Haklex富源编辑器主题系统的设计符,CSS变量和变体预设.
安装
pnpm add @haklex/rich-style-token
同伴依赖关系
使用量
import { createThemeStyle, articleTheme, vars } from '@haklex/rich-style-token'
import { PortalThemeProvider } from '@haklex/rich-style-token'
// Generate inline style object from a theme
const style = createThemeStyle(articleTheme)
// Use CSS variables in your styles
// vars.fontSize, vars.lineHeight, vars.fontFamily, etc.
// Provide portal theme context for overlays
<PortalThemeProvider theme="light" variant="article">
{children}
</PortalThemeProvider>
东道主主题
每个颜色符号和每个字体家庭符号首先通过主机变量解决:
--rc-text: var(--rc-host-text, #171717);
--rc-font-family-sans: var(--rc-host-font-family-sans, -apple-system, …);
主机通过定义重映射编辑器 --rc-host-* 曾经 :root。数值达到内容,可编辑的表面,以及光和暗两种模式的入门铬(菜单、工具提示、工具栏),所以主机拥有自己的光/暗切换:
:root {
--rc-host-text: var(--color-fg);
--rc-host-bg: var(--color-surface-card);
--rc-host-border: var(--color-border);
--rc-host-accent: var(--color-accent);
}
主机变量名称是符号名称 --rc- 改为 --rc-host- (单位:千美元)--rc-text-secondary → --rc-host-text-secondary) (中文(简体) ). 设置 --rc-* 直接在元素上( 例如 --rc-font-family 仍然为那棵树工作.
出口
主题 建筑
| 导出 | 说明 |
createThemeStyle(tokens) | 从主题符号生成一个 CSS 变量样式对象 |
上下文提供者
| 导出 | 说明 |
PortalContainerProvider | 提供自定义门户容器元素 |
usePortalContainer() | 访问门户容器元素 |
PortalThemeProvider | 为门户覆盖提供主题上下文 |
PortalThemeWrapper | 应用主题变量的折叠元素 |
usePortalTheme() | 访问当前门户网站主题 |
设计托肯斯
| 导出 | 说明 |
articleLayout | 组合符号 article 变体(sans-serif, 16px) |
noteLayout | 组合符号 note 变体( CJK serif, 16px) |
commentLayout | 组合符号 comment 变体(sans-serif, 14px) |
darkColors | 暗模式的颜色符号 |
lightArticleColors | 轻型文章/注解模式的颜色符号 |
lightCommentColors | 光评分模式的颜色符号 |
fonts | 字体家族定义 |
主题对象
| 导出 | 说明 |
articleTheme | 联合国 article 变体 |
noteTheme | 联合国 note 变体 |
commentTheme | 联合国 comment 变体 |
vars | 已键入的 CSS 变量引用( 用于 Vanilla 提取样式) |
类型
| 导出 | 说明 |
ThemeTokens | 完整的主题符号集形状 |
PortalTheme | 门户主题描述符 |
子路径导出
| 导入路径 | 说明 |
@haklex/rich-style-token | 所有标志、主题、提供者和公用事业 |
@haklex/rich-style-token/styles | 香草提取样式定义 |
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院