BulletList

Organize paragraphs into an unordered list.

Setup

Start with the packages in Getting Started. Install @tiptap/extension-list at the same version as your other Tiptap packages. This complete example registers the feature and renders its UI. In an existing editor, merge the imports and extension entries into your setup, and place the controls inside your existing RichTextProvider.

tsx

'use client';

import { EditorContent, useEditor } from '@tiptap/react';
import { Document } from '@tiptap/extension-document';
import { Paragraph } from '@tiptap/extension-paragraph';
import { Text } from '@tiptap/extension-text';
import { RichTextProvider } from 'reactjs-tiptap-editor';
import { BulletList, RichTextBulletList } from 'reactjs-tiptap-editor/bulletlist';
import { ListItem } from '@tiptap/extension-list';
import 'reactjs-tiptap-editor/style.css';

const extensions = [Document, Paragraph, Text, ListItem, BulletList];

export default function BulletListExample() {
  const editor = useEditor({
    extensions,
    content: '<p>Try this feature here.</p>',
    immediatelyRender: false,
  });

  if (!editor) return null;

  return (
    <RichTextProvider editor={editor}>
      <RichTextBulletList />
      <EditorContent editor={editor} />
    </RichTextProvider>
  );
}

How to use

Register ListItem alongside BulletList; it defines the content of each list entry. Place the cursor in a paragraph and click the list button. Use editor.chain().focus().toggleBulletList().run() from a custom control.