@godxjp/editor

中文文档
33.30.5发布于 2026/11/14Apache-2.0TypeScriptES Module近 30 天下载 1.1万

GODX应用的马克下行编辑器:格式化工具栏,与@godxjp/markdown并肩写出/预览/并肩写出,粘贴/放出/通过主机上行功能附加,IME安全,ja/en/vi.

中文使用文档

@ godxjp/编辑器

GODX apps 的 Markdown 编辑器: 格式化工具栏, 并肩写/ 预览/ 预览 执行人: @godxjp/markdown (与公布的页面相同的疗养),和文件 通过上传函数粘贴、丢弃或附加 主机 提供.

pnpm add @godxjp/editor @godxjp/markdown @godxjp/ui
import { MarkdownEditor } from "@godxjp/editor";
import { FormField } from "@godxjp/ui/data-entry";

<FormField id="body" label="本文">
  <MarkdownEditor
    value={body}
    onValueChange={setBody}
    upload={async (file) => ({ url: await storage.put(file) })}
  />
</FormField>;

行为

  • 这是装备箱的 Textarea: 日本的IME组成、本土护理、拼写检查和 浏览器的撤销继续工作。 每个工具栏编辑是 一个 撤销台阶.
  • QQ/Ctrl + B, I, K——粗体,斜体,链接. IME组装期间不要开火.
  • 工具栏是WAI-ARIA工具栏(一制表站,箭头键). 在预览中,或何时 disabled 编号 : readOnly,其行动仍可集中但无所作为(aria-disabled) (中文(简体) ).
  • 文件 : upload(file) => Promise<{ url, name? }>上传并替换一个占位符 以 ![name](url) (图像)或 [name](url); 失败会删除, 并说哪个文件失败 . uploadBlockedReason 拒绝带主机消息的文件——无论是否 upload(单位:千美元) 粘贴或被丢弃的文件显示它,附件按钮命名原因并显示时间 而不是打开取出器。 没有道具,文件就留给了浏览器.
  • 弦取自工具包的目录 ja / en / vi; labels 超过其中任何一个.

道具

道具
value 编号 : defaultValue 编号 : onValueChange马克下发的短信.
mode 编号 : defaultMode 编号 : onModeChange"write" | "preview" | "split"。 。 。 .
upload, (中文(简体) ), uploadBlockedReason文件,通过主机存储.
renderPreview(value)替换预览( 一个应用 ) .
actions额外的工具栏动作 { key, label, icon, run(api) } 新区块类型的扩展点; api 已经 value, (中文(简体) ), selection, (中文(简体) ), edit, (中文(简体) ), insert, (中文(简体) ), focus。 。 。 .
labels覆盖字符串 .
rows, (中文(简体) ), disabled, (中文(简体) ), readOnly, (中文(简体) ), id, (中文(简体) ), aria-*,, , , , , , , , 传入文字区.

onKeyDown 从主机先运行;如果它调用 preventDefault(),编辑器的快捷键不会 运行 —— 因此在编辑器周围包裹的提及或链接自动完成保留其密钥 .

版本与发布记录

@godxjp/editor 共发布 143 个版本,首次发布于 2026/10/02;过去 12 个月发布了 143 个版本。

版本发布日期距今
33.30.5latest2026/11/143 天前
33.30.42026/11/133 天前
33.30.32026/11/133 天前
33.28.62026/11/106 天前
33.28.42026/11/106 天前
33.28.32026/11/106 天前

关于 @godxjp/editor 的常见问题

@godxjp/editor 是什么?

GODX应用的马克下行编辑器:格式化工具栏,与@godxjp/markdown并肩写出/预览/并肩写出,粘贴/放出/通过主机上行功能附加,IME安全,ja/en/vi.

如何安装 @godxjp/editor?

在项目目录运行 npm install @godxjp/editor,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19.0.0)、@godxjp/ui(~33.30.5)、@godxjp/markdown(~33.30.5)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@godxjp/editor 支持 TypeScript 吗?

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

@godxjp/editor 支持 ESM 还是 CommonJS?

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

@godxjp/editor 可以商用吗?

@godxjp/editor 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@godxjp/editor 的下载量有多少?

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

@godxjp/editor 还在维护吗?

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