@tiptap/extension-bullet-list

What is @tiptap/extension-bullet-list?

@tiptap/extension-bullet-list is an extension for the Tiptap editor that allows users to create and manage bullet lists within their rich text content. It provides a straightforward way to add, edit, and manipulate bullet lists, making it easier to organize content in a structured manner.

What are @tiptap/extension-bullet-list's main functionalities?

Add Bullet List

This feature allows you to add a bullet list to your Tiptap editor. The code initializes the editor with the BulletList extension and then toggles the bullet list on the focused editor.

import { BulletList } from '@tiptap/extension-bullet-list';

const editor = new Editor({
  extensions: [
    BulletList,
  ],
});

editor.chain().focus().toggleBulletList().run();

Toggle Bullet List

This feature allows you to toggle a bullet list on and off within the editor. The code focuses on the editor and toggles the bullet list state.

editor.chain().focus().toggleBulletList().run();

Check if Selection is Bullet List

This feature checks if the current selection in the editor is a bullet list. The code returns a boolean indicating whether the selection is a bullet list.

const isBulletList = editor.isActive('bulletList');

Other packages similar to @tiptap/extension-bullet-list

prosemirror-schema-list

prosemirror-schema-list is a ProseMirror schema extension that provides list item and ordered list nodes. It offers similar functionality to @tiptap/extension-bullet-list but is more low-level and requires more setup to integrate with an editor.

slate-react

slate-react is a framework for building rich text editors with Slate and React. It provides a more customizable and flexible approach to handling lists, including bullet lists, compared to @tiptap/extension-bullet-list.

draft-js

draft-js is a framework for building rich text editors in React. It includes built-in support for bullet lists and other list types, offering a similar feature set to @tiptap/extension-bullet-list but with a different API and integration approach.

README

@tiptap/extension-bullet-list

Introduction

tiptap is a headless wrapper around ProseMirror – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as New York Times, The Guardian or Atlassian.

Offical Documentation

Documentation can be found on the tiptap website.

License

tiptap is open-sourced software licensed under the MIT license.