让开源，少一点语言距离。
npm包中文文档

@doist/typist

中文文档
17.1.2发布于 2026/11/11MITTypeScriptES Module构建来源已验证近 30 天下载 3344

The mighty Tiptap-based rich-text editor React component that powers Doist products.

此软件包已被标记为弃用

Moved to @todoist/typist. Replace @doist/typist with @todoist/typist in your dependencies and imports.

原始使用文档
中文原文
文档目录5 节
  1. Installation
  2. Usage
  3. Resources
  4. Contributing
  5. License

Typist is the mighty Tiptap-based rich-text editor React component that powers Todoist products, which can also be used for displaying content in a read-only fashion. Typist also supports a plain-text mode, and comes with HTML/Markdown serializers.

Note

This project is not attempting to be an all-purpose rich-text editor. Whilst everyone is welcome to fork or use this package in their own products, development decisions are centered around Todoist product requirements.

GitHub: CI Validation npm Version npm Bundle Size (minified) npm Downloads (monthly)

semantic-release: Conventional Commits Contributor Covenant License: MIT

Installation

npm install --save @doist/typist

Usage

import { TypistEditor, RichTextKit } from '@doist/typist'

function TypistEditorContainer({ content }) {
    return (
        <TypistEditor
            placeholder="A full rich-text editor, be creative…"
            content={content}
            extensions={[RichTextKit]}
        />
    )
}

Note

content, extensions, and placeholder are initialization-only: they're read when the editor first mounts, and later changes to these props are ignored. See the Component Lifecycle documentation for how to handle runtime changes.

If you're looking for additional documentation, in-depth examples, or a live demo, please check out our Storybook.

Resources

A curated list of open-source rich-text editors powered by Tiptap that we can draw inspiration from:

Contributing

If you're interested in contributing code and/or documentation, please read our contributing guide.

License

The use of this source code is governed by an MIT-style license that can be found in the LICENSE file.

版本与发布记录

@doist/typist 共发布 142 个版本，首次发布于 2022/11/05；过去 12 个月发布了 42 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
17.1.2latest2026/11/112 天前
17.1.12026/11/103 天前
17.1.02026/11/103 天前
17.0.82026/11/103 天前
17.0.72026/11/094 天前
17.0.62026/10/3014 天前

其他发布通道：next → 15.0.0-next.3。

关于 @doist/typist 的常见问题

@doist/typist 是什么？

The mighty Tiptap-based rich-text editor React component that powers Doist products.注意：该包已被作者标记为弃用——Moved to @todoist/typist. Replace @doist/typist with @todoist/typist in your dependencies and imports.

如何安装 @doist/typist？

在项目目录运行 npm install @doist/typist，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18.0.0 || ^19.0.0）、linkifyjs（^4.3.2）、lodash-es（^4.17.21）、react-dom（^18.0.0 || ^19.0.0）、emoji-regex（^10.2.1 || ^11.0.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

@doist/typist 支持 TypeScript 吗？

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

@doist/typist 支持 ESM 还是 CommonJS？

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

@doist/typist 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >= 24.13.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@doist/typist 可以商用吗？

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

@doist/typist 的下载量有多少？

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

@doist/typist 还在维护吗？

最新版本 17.1.2 发布于 2026/11/11（2 天前）；至今共发布 142 个版本，其中过去 12 个月发布了 42 个；首次发布于 2022/11/05。作者已将其标记为弃用，新项目建议寻找替代方案。