无序列表

该扩展会使编辑器识别<ul>标签。 在新行的开头输入*，-，+会将该行转换为无序列表。

安装

npm install @tiptap/extension-bullet-list @tiptap/extension-list-item

用法示例

🌰 举个例子

import BulletList from '@tiptap/extension-bullet-list'
import Document from '@tiptap/extension-document'
import ListItem from '@tiptap/extension-list-item'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { EditorContent, useEditor } from '@tiptap/react'
import React from 'react'

export default () => {
  const editor = useEditor({
    extensions: [Document, Paragraph, Text, BulletList, ListItem],
    content: `
        <ul>
          <li>列表项</li>
          <li>还有一个</li>
        </ul>
      `,
  })

  if (!editor) {
    return null
  }

  return (
    <>
      <button
        onClick={() => editor.chain().focus().toggleBulletList().run()}
        className={editor.isActive('bulletList') ? 'is-active' : ''}
      >
        切换ul
      </button>
      <button
        onClick={() => editor.chain().focus().splitListItem('listItem').run()}
        disabled={!editor.can().splitListItem('listItem')}
      >
        更改ul的type为disc
      </button>
      <button
        onClick={() => editor.chain().focus().sinkListItem('listItem').run()}
        disabled={!editor.can().sinkListItem('listItem')}
      >
        更改ul的type为circle
      </button>
      <button
        onClick={() => editor.chain().focus().liftListItem('listItem').run()}
        disabled={!editor.can().liftListItem('listItem')}
      >
        取消ul
      </button>

      <EditorContent editor={editor} />
    </>
  )
}

API

方法	说明	使用方法
toggleBulletList()	切换	editor.commands.toggleBulletList()

键盘快捷键

命令	Windows/Linux	macOS
toggleBulletList	Control Shift 8	Cmd Shift 8

源码

github