@udecode/plate-list

What is @udecode/plate-list?

@udecode/plate-list is a plugin for the Plate editor, which is a rich text editor framework built on top of Slate. This package provides functionality for creating and managing lists within the editor, including ordered lists, unordered lists, and nested lists.

What are @udecode/plate-list's main functionalities?

Creating Unordered Lists

This code demonstrates how to set up a Plate editor with the list plugin to enable unordered list functionality.

import { createPlateUI, Plate } from '@udecode/plate';
import { createListPlugin } from '@udecode/plate-list';

const plugins = [
  createListPlugin(),
];

const MyEditor = () => (
  <Plate plugins={plugins} />
);

Creating Ordered Lists

This code shows how to configure the Plate editor to support ordered lists using the list plugin.

import { createPlateUI, Plate } from '@udecode/plate';
import { createListPlugin } from '@udecode/plate-list';

const plugins = [
  createListPlugin(),
];

const MyEditor = () => (
  <Plate plugins={plugins} />
);

Nested Lists

This example demonstrates how to enable nested list functionality in the Plate editor using the list plugin.

import { createPlateUI, Plate } from '@udecode/plate';
import { createListPlugin } from '@udecode/plate-list';

const plugins = [
  createListPlugin(),
];

const MyEditor = () => (
  <Plate plugins={plugins} />
);

Other packages similar to @udecode/plate-list

slate-react

slate-react is a package that provides React bindings for Slate, a completely customizable framework for building rich text editors. While it does not come with built-in list management, it allows developers to create custom plugins to handle lists, similar to @udecode/plate-list.

draft-js

draft-js is a rich text editor framework by Facebook. It includes built-in support for lists, both ordered and unordered, but does not offer the same level of customization and extensibility as @udecode/plate-list.

prosemirror

prosemirror is a toolkit for building rich text editors. It provides extensive support for lists and other rich text features, but requires more setup and configuration compared to @udecode/plate-list.

README

Plate list plugin

This package implements the list plugin for Plate.

Documentation

Check out List.

API

See the API documentation.

License

MIT