@udecode/plate-common

What is @udecode/plate-common?

@udecode/plate-common is a part of the Plate framework, which is a rich text editor built on top of Slate. This package provides common utilities, types, and constants that are used across various Plate plugins and components.

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

Utility Functions

The package provides various utility functions that can be used to manipulate and interact with the editor state and content.

const { someUtilityFunction } = require('@udecode/plate-common');

// Example usage
const result = someUtilityFunction(args);

Types and Constants

It includes a set of predefined types and constants that help in maintaining consistency and reducing errors when working with the Plate editor.

const { SOME_CONSTANT, SomeType } = require('@udecode/plate-common');

// Example usage
console.log(SOME_CONSTANT);

/** @type {SomeType} */
const someVariable = { /* ... */ };

Plugin Helpers

The package offers helper functions to create and manage plugins, making it easier to extend the functionality of the Plate editor.

const { createPluginHelper } = require('@udecode/plate-common');

// Example usage
const myPlugin = createPluginHelper({ /* plugin options */ });

Other packages similar to @udecode/plate-common

slate

Slate is a completely customizable framework for building rich text editors. It provides the core editor logic and allows developers to build their own plugins and components. Compared to @udecode/plate-common, Slate is more low-level and requires more setup and customization.

draft-js

Draft.js is a rich text editor framework built by Facebook. It provides a set of React components and utilities for building rich text editors. While it offers a lot of built-in functionality, it is less flexible compared to the Plate framework and @udecode/plate-common.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on extensibility and performance. It provides a set of core modules and allows developers to build custom plugins. ProseMirror is more complex and powerful compared to @udecode/plate-common, but it also requires a steeper learning curve.

README

Plate utils

License

MIT