@haklex/rich-style-token

中文文档
0.66.0发布于 2026/11/15MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 2.4万

Style tokens and CSS variables for haklex rich editor

原始使用文档
文档目录13 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Host Theming
  5. Exports
  6. Theme Construction
  7. Context Providers
  8. Design Tokens
  9. Theme Objects
  10. Types
  11. Sub-path Exports
  12. Part of Haklex
  13. License

@haklex/rich-style-token

Design tokens, CSS variables, and variant presets for the Haklex rich editor theme system.

Installation

pnpm add @haklex/rich-style-token

Peer Dependencies

PackageVersion
react>=19

Usage

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>

Host Theming

Every color token and every font-family token resolves through a host variable first:

--rc-text: var(--rc-host-text, #171717);
--rc-font-family-sans: var(--rc-host-font-family-sans, -apple-system, …);

A host remaps the editor by defining --rc-host-* once on :root. The value reaches content, the editable surface, and portaled chrome (menus, tooltips, toolbars) in both light and dark mode, so the host owns its own light/dark switching:

: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);
}

The host variable name is the token name with --rc- replaced by --rc-host- (--rc-text-secondary → --rc-host-text-secondary). Setting --rc-* directly on an element (for example --rc-font-family inline) still works for that subtree.

Exports

Theme Construction

ExportDescription
createThemeStyle(tokens)Generate a CSS variable style object from theme tokens

Context Providers

ExportDescription
PortalContainerProviderProvide a custom portal container element
usePortalContainer()Access the portal container element
PortalThemeProviderProvide theme context for portaled overlays
PortalThemeWrapperWrapper element that applies theme variables
usePortalTheme()Access the current portal theme

Design Tokens

ExportDescription
articleLayoutLayout tokens for the article variant (sans-serif, 16px)
noteLayoutLayout tokens for the note variant (CJK serif, 16px)
commentLayoutLayout tokens for the comment variant (sans-serif, 14px)
darkColorsColor tokens for dark mode
lightArticleColorsColor tokens for light article/note mode
lightCommentColorsColor tokens for light comment mode
fontsFont family definitions

Theme Objects

ExportDescription
articleThemeComplete theme for the article variant
noteThemeComplete theme for the note variant
commentThemeComplete theme for the comment variant
varsTyped CSS variable references (use in Vanilla Extract styles)

Types

ExportDescription
ThemeTokensShape of a complete theme token set
PortalThemePortal theme descriptor

Sub-path Exports

Import PathDescription
@haklex/rich-style-tokenAll tokens, themes, providers, and utilities
@haklex/rich-style-token/stylesVanilla Extract style definitions

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-style-token 共发布 241 个版本,首次发布于 2026/02/20;过去 12 个月发布了 241 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.66.0latest2026/11/151 天前
0.65.72026/11/143 天前
0.65.62026/11/124 天前
0.65.52026/11/124 天前
0.65.42026/11/124 天前
0.65.32026/11/124 天前

关于 @haklex/rich-style-token 的常见问题

@haklex/rich-style-token 是什么?

Style tokens and CSS variables for haklex rich editor

如何安装 @haklex/rich-style-token?

在项目目录运行 npm install @haklex/rich-style-token,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haklex/rich-style-token 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haklex/rich-style-token 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@haklex/rich-style-token 可以商用吗?

@haklex/rich-style-token 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@haklex/rich-style-token 的下载量有多少?

根据 npm 官方下载统计,@haklex/rich-style-token 在 2026/10/17 – 2026/11/15 这 30 天内被下载 23,831 次,日均约 794 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haklex/rich-style-token 还在维护吗?

最新版本 0.66.0 发布于 2026/11/15(1 天前);至今共发布 241 个版本,其中过去 12 个月发布了 241 个;首次发布于 2026/02/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。