@types/draft-js

What is @types/draft-js?

@types/draft-js provides TypeScript definitions for the Draft.js library, which is a rich text editor framework for React. These type definitions help developers use Draft.js in TypeScript projects by providing type safety and IntelliSense support.

What are @types/draft-js's main functionalities?

EditorState

The EditorState is a core concept in Draft.js, representing the state of the editor. This includes the current content, selection, and undo/redo history.

const editorState = EditorState.createEmpty();

ContentState

ContentState represents the content of the editor. It can be created from plain text, and it is used to initialize or update the EditorState.

const contentState = ContentState.createFromText('Hello, world!');

RichUtils

RichUtils provides utility functions for common rich text operations, such as toggling inline styles (e.g., bold, italic) and block types (e.g., header, list).

const newState = RichUtils.toggleInlineStyle(editorState, 'BOLD');

Editor Component

The Editor component is the main UI component of Draft.js. It takes an EditorState and an onChange handler as props to manage the editor's state.

import { Editor } from 'draft-js';

<Editor editorState={editorState} onChange={setEditorState} />

Other packages similar to @types/draft-js

slate

Slate is another framework for building rich text editors in React. It provides a more flexible and customizable approach compared to Draft.js, allowing developers to define their own data models and rendering logic.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on extensibility and customizability. It offers a more modular architecture compared to Draft.js, making it suitable for complex editing scenarios.

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides a simple API and a rich set of features out of the box, making it a good alternative to Draft.js for straightforward rich text editing needs.

README

Installation

npm install --save @types/draft-js

Summary

This package contains type definitions for draft-js 0.2.2 (https://github.com/facebook/draft-js).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/draft-js

Additional Details

• Last updated: Fri, 20 May 2016 17:00:15 GMT
• File structure: ProperModule
• Library Dependencies: none
• Module Dependencies: none
• Global values: Draft

Credits

These definitions were written by Pavel Evsegneev https://github.com/Ahineya.