draft-js
Advanced tools
Package description
Draft.js is a JavaScript rich text editor framework, built for React. It provides a set of immutable models and helper functions for creating rich text editors with a high degree of customization and control over the content and behavior.
Creating a Basic Editor
This code demonstrates how to create a basic rich text editor using Draft.js. It initializes an empty editor state and renders the editor component.
import React from 'react';
import { Editor, EditorState } from 'draft-js';
import 'draft-js/dist/Draft.css';
class MyEditor extends React.Component {
constructor(props) {
super(props);
this.state = { editorState: EditorState.createEmpty() };
this.onChange = (editorState) => this.setState({ editorState });
}
render() {
return (
<Editor editorState={this.state.editorState} onChange={this.onChange} />
);
}
}
export default MyEditor;Handling Text Formatting
This code demonstrates how to handle text formatting commands in Draft.js. It uses the `RichUtils.handleKeyCommand` method to apply formatting like bold, italic, etc., based on keyboard shortcuts.
import React from 'react';
import { Editor, EditorState, RichUtils } from 'draft-js';
import 'draft-js/dist/Draft.css';
class MyEditor extends React.Component {
constructor(props) {
super(props);
this.state = { editorState: EditorState.createEmpty() };
this.onChange = (editorState) => this.setState({ editorState });
this.handleKeyCommand = this.handleKeyCommand.bind(this);
}
handleKeyCommand(command, editorState) {
const newState = RichUtils.handleKeyCommand(editorState, command);
if (newState) {
this.onChange(newState);
return 'handled';
}
return 'not-handled';
}
render() {
return (
<Editor
editorState={this.state.editorState}
handleKeyCommand={this.handleKeyCommand}
onChange={this.onChange}
/>
);
}
}
export default MyEditor;Custom Block Rendering
This code demonstrates how to implement custom block rendering in Draft.js. It defines a custom block renderer function and a custom block component to render specific types of content blocks.
import React from 'react';
import { Editor, EditorState, ContentBlock } from 'draft-js';
import 'draft-js/dist/Draft.css';
function myBlockRenderer(contentBlock) {
const type = contentBlock.getType();
if (type === 'atomic') {
return {
component: MyCustomBlockComponent,
editable: false,
};
}
}
class MyCustomBlockComponent extends React.Component {
render() {
return <div>My Custom Block</div>;
}
}
class MyEditor extends React.Component {
constructor(props) {
super(props);
this.state = { editorState: EditorState.createEmpty() };
this.onChange = (editorState) => this.setState({ editorState });
}
render() {
return (
<Editor
editorState={this.state.editorState}
onChange={this.onChange}
blockRendererFn={myBlockRenderer}
/>
);
}
}
export default MyEditor;Slate is a completely customizable framework for building rich text editors. Unlike Draft.js, which provides a more opinionated structure, Slate offers more flexibility and control over the editor's behavior and appearance. It uses a more modern approach with a focus on immutability and functional programming.
Quill is a powerful, rich text editor that provides a wide range of features out of the box. It is more feature-rich and easier to set up compared to Draft.js, but it offers less flexibility for customization and control over the editor's internals.
ProseMirror is a toolkit for building rich text editors with a focus on extensibility and customizability. It provides a more modular approach compared to Draft.js, allowing developers to build complex editors with custom behaviors and features.
Changelog
0.10.5 (January 19th, 2018)
ariaDescribedBy prop, for better a11y. (Suraj Karnati in
a6af3e15)ariaLabelledBy prop, for better a11y. (@jackyho112
in #1519)cannot read property 'update' of undefined error that was thrown when
typing same character into selection that starts with that character. (@existentialism in
#1512)encodeRawBlocks to handle non-contiguous entities. Entities should
always be contiguous, and cover one sequential range of characters. However,
in cases where entityState is corrupted to include non-contiguous entities,
encodeRawBlocks would improperly process the entities in that case. (Frank
Thompson in 0059dd46)Readme
Draft.js is a JavaScript rich text editor framework, built for React and backed by an immutable model.
Learn how to use Draft.js in your own project.
Before getting started, please be aware that we recently changed the API of
Entity storage in Draft. The latest version, v0.10.0, supports both the old
and new API. Following that up will be v0.11.0 which will remove the old API.
If you are interested in helping out, or tracking the progress, please follow
issue 839.
Currently Draft.js is distributed via npm. It depends on React and React DOM which must also be installed.
npm install --save draft-js react react-dom
or
yarn add draft-js react react-dom
import React from 'react';
import ReactDOM from 'react-dom';
import {Editor, EditorState} from 'draft-js';
class MyEditor extends React.Component {
constructor(props) {
super(props);
this.state = {editorState: EditorState.createEmpty()};
this.onChange = (editorState) => this.setState({editorState});
}
render() {
return (
<Editor editorState={this.state.editorState} onChange={this.onChange} />
);
}
}
ReactDOM.render(
<MyEditor />,
document.getElementById('container')
);
Because Draft.js supports unicode, you must have the following meta tag in the <head> </head> block of your HTML file:
<meta charset="utf-8" />
Further examples of how Draft.js can be used are provided below.
Visit http://draftjs.org/ to try out a simple rich editor example.
The repository includes a variety of different editor examples to demonstrate some of the features offered by the framework.
To run the examples, first build Draft.js locally:
git clone https://github.com/facebook/draft-js.git
cd draft-js
npm install
npm run build
then open the example HTML files in your browser.
Draft.js is used in production on Facebook, including status and comment inputs, Notes, and messenger.com.
 IE / Edge |  Firefox |  Chrome |  Safari |  iOS Safari |  Chrome for Android |
|---|---|---|---|---|---|
| IE11, Edge [1, 2] | last 2 versions | last 2 versions | last 2 versions | not fully supported [3] | not fully supported [3] |
[1] May need a shim or a polyfill for some syntax used in Draft.js (docs).
[2] IME inputs have known issues in these browsers, especially Korean (docs).
[3] There are known issues with mobile browsers, especially on Android (docs).
Check out this curated list of articles and open-sourced projects/utilities: Awesome Draft-JS.
Join our Slack team!
We actively welcome pull requests. Learn how to contribute.
Draft.js is BSD Licensed. We also provide an additional patent grant.
Examples provided in this repository and in the documentation are separately licensed.
FAQs
A React framework for building text editors.
We found that draft-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.
Security News
ua-parser-js is set to drop the MIT license and adopt a controversial dual AGPLv3 + PRO licensing model in its upcoming v2.0 release, raising significant concerns among developers and enterprise users.