当前位置:首页 > 技术 > 正文内容

在 Tiptap 中实现有序列表功能

访客 技术 2026年7月11日 4

在使用 Tiptap 时,若发现有序列表无法正常工作,最常见的原因是安装了扩展包但未将其添加到编辑器的 extensions 数组中。

安装 @tiptap/extension-ordered-list 仅将依赖项引入项目目录,仍需显式告知编辑器实例启用该功能。此外,为确保列表正确渲染,通常还需包含 ListItem 扩展,它在使用 StarterKit 时已自动集成。若未使用 StarterKit,则必须手动引入 DocumentParagraphTextListItem 等基础扩展。 以下是正确配置步骤:
  1. 导入所需扩展
    import { useEditor, EditorContent } from '@tiptap/react';
    import StarterKit from '@tiptap/starter-kit';
    import OrderedList from '@tiptap/extension-ordered-list';
    
    // 若未使用 StarterKit,还需额外导入:
    // import ListItem from '@tiptap/extension-list-item';
    // import Paragraph from '@tiptap/extension-paragraph';
    // import Document from '@tiptap/extension-document';
    // import Text from '@tiptap/extension-text';
  2. 在初始化编辑器时注册扩展 这是关键步骤。
    const MyEditor = () => {
      const editor = useEditor({
        extensions: [
          // 启用 StarterKit 并配置其有序列表行为
          StarterKit.configure({
            orderedList: {
              keepMarks: true,     // 保留格式(如粗体、斜体)
              keepAttributes: false, // 不保留自定义属性
            },
          }),
    
          // 若禁用了 StarterKit 内置的有序列表,或从零构建扩展,需单独添加:
          // OrderedList.configure({
          //   HTMLAttributes: {
          //     class: 'custom-ordered-list',
          //   },
          // }),
          // ListItem,
          // Paragraph,
          // Document,
          // Text,
          // BulletList, // 如需同时支持无序列表
        ],
        content: '<p>这是一个段落。</p><p>第二行内容。</p>',
      });
    
      if (!editor) return null;
    
      const toggleList = () => {
        editor.chain().focus().toggleOrderedList().run();
      };
    
      return (
        <div>
          <button
            onClick={toggleList}
            disabled={!editor.can().toggleOrderedList()}
            className="px-2 py-1 text-sm"
          >
            <svg width="16" height="16">
              <circle cx="4" cy="8" r="2" fill="currentColor"/>
              <circle cx="8" cy="8" r="2" fill="currentColor"/>
              <circle cx="12" cy="8" r="2" fill="currentColor"/>
              <line x1="2" y1="4" x2="14" y2="4" stroke="currentColor" strokeWidth="1.5" />
              <line x1="2" y1="12" x2="14" y2="12" stroke="currentColor" strokeWidth="1.5" />
            </svg>
          </button>
          <EditorContent editor={editor} />
        </div>
      );
    };
    
    export default MyEditor;

核心说明:

  • import OrderedList:引入有序列表功能模块。
  • StarterKit.configure({ orderedList: ... }):若使用 StarterKit,可直接通过配置调整默认行为。该套件已内置 OrderedList,无需重复添加。
  • OrderedList.configure(...):当不使用 StarterKit,或主动关闭其默认实现时,才需手动加入,并确保 ListItemParagraph 等基础扩展也一并注册。

排查建议:

  • 检查浏览器开发者工具中的错误日志,关注与 Tiptap 相关的异常。
  • 确认 ListItem 是否存在于扩展列表中,它是有序列表运作的基础。
  • 可通过 console.log(editor.isActive('orderedList')) 验证当前光标是否处于有序列表状态。
只要将 OrderedList 正确注入 extensions 数组,即可实现按钮控制有序列表的切换功能。

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。