@haklex/rich-renderer-ruby

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

Ruby annotation renderer for haklex rich editor

原始使用文档
文档目录9 节
  1. Installation
  2. Peer Dependencies
  3. Usage
  4. Exports
  5. Components
  6. Types
  7. Sub-path Exports
  8. Part of Haklex
  9. License

@haklex/rich-renderer-ruby

Ruby annotation renderer for CJK text, providing furigana (reading aids) above base characters.

Installation

pnpm add @haklex/rich-renderer-ruby

Peer Dependencies

PackageVersion
react>=19
react-dom>=19

Usage

import { RubyRenderer } from '@haklex/rich-renderer-ruby/static'

// Register in a static RendererConfig
const rendererConfig = {
  // ...other renderers
  ruby: RubyRenderer,
}

For edit mode:

import { RubyEditRenderer } from '@haklex/rich-renderer-ruby'

const editRendererConfig = {
  // ...other renderers
  ruby: RubyEditRenderer,
}

Exports

Components

  • RubyRenderer — Static (read-only) renderer for ruby annotations
  • RubyEditRenderer — Edit (interactive) renderer with annotation editing

Types

  • RubyRendererProps — Props interface for the ruby renderer component

Sub-path Exports

PathDescription
@haklex/rich-renderer-rubyFull exports (edit + static)
@haklex/rich-renderer-ruby/staticStatic-only renderer
@haklex/rich-renderer-ruby/style.cssStylesheet

Part of Haklex

This package is part of the Haklex rich editor ecosystem.

License

MIT

版本与发布记录

@haklex/rich-renderer-ruby 共发布 195 个版本,首次发布于 2026/02/28;过去 12 个月发布了 195 个版本。最新版本附带 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-renderer-ruby 的常见问题

@haklex/rich-renderer-ruby 是什么?

Ruby annotation renderer for haklex rich editor

如何安装 @haklex/rich-renderer-ruby?

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

@haklex/rich-renderer-ruby 支持 TypeScript 吗?

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

@haklex/rich-renderer-ruby 支持 ESM 还是 CommonJS?

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

@haklex/rich-renderer-ruby 可以商用吗?

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

@haklex/rich-renderer-ruby 的下载量有多少?

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

@haklex/rich-renderer-ruby 还在维护吗?

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