@godxjp/editor

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

Markdown editor for GoDX apps: formatting toolbar, write / preview / side by side with @godxjp/markdown, paste / drop / attach through a host upload function, IME-safe, ja / en / vi.

原始使用文档

@godxjp/editor

The Markdown editor for GoDX apps: a formatting toolbar, write / preview / side by side, a preview rendered by @godxjp/markdown (the same sanitiser as the published page), and files pasted, dropped or attached through an upload function the host provides.

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>;

Behaviour

  • It is the kit's Textarea: Japanese IME composition, the native caret, spell-check and the browser's undo keep working. Every toolbar edit is one undo step.
  • ⌘/Ctrl + B, I, K — bold, italic, link. Never fire during IME composition.
  • The toolbar is a WAI-ARIA toolbar (one tab stop, arrow keys). In preview, or when disabled / readOnly, its actions stay focusable but do nothing (aria-disabled).
  • Files: upload(file) => Promise<{ url, name? }>. A placeholder marks each upload and is replaced by ![name](url) (images) or [name](url); a failure removes it and says which file failed. uploadBlockedReason refuses files with the host's message — with or without upload: a pasted or dropped file shows it, and the attach button names the reason and shows it when pressed instead of opening the picker. With neither prop, files are left to the browser.
  • Strings come from the kit's catalogue in ja / en / vi; labels overrides any of them.

Props

prop
value / defaultValue / onValueChangeThe Markdown text.
mode / defaultMode / onModeChange"write" | "preview" | "split".
upload, uploadBlockedReasonFiles, through the host's storage.
renderPreview(value)Replace the preview (an app with its own embeds).
actionsExtra toolbar actions { key, label, icon, run(api) } — the extension point for new block types; api has value, selection, edit, insert, focus.
labelsOverride strings.
rows, disabled, readOnly, id, aria-*, …Passed to the textarea.

onKeyDown from the host runs first; if it calls preventDefault(), the editor's shortcut does not run — so a mention or link autocomplete wrapped around the editor keeps its keys.

版本与发布记录

@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 是什么?

Markdown editor for GoDX apps: formatting toolbar, write / preview / side by side with @godxjp/markdown, paste / drop / attach through a host upload function, IME-safe, 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 和提交记录判断。