Draft.js

A React framework for building text editors.

Rich text editor
facebookarchive/draft-jsdraftjs.org/draft-js

README

draftjs-logo

  Draft.js

Build Status npm version

Live Demo


Status


THIS PROJECT IS CURRENTLY IN MAINTENANCE MODE. It will not receive any feature updates, only critical security bug patches. On 31st December 2022 the repo will be fully archived.

For users looking for an open source alternative, Meta have been working on migrating to a new framework, called Lexical. It's still experimental, and we're working on adding migration guides, but, we believe, it provides a more performant and accessible alternative.

Draft.js is a JavaScript rich text editor framework, built for React and
backed by an immutable model.

- Extensible and Customizable: We provide the building blocks to enable
the creation of a broad variety of rich text composition experiences, from
basic text styles to embedded media.
- Declarative Rich Text: Draft.js fits seamlessly into
React applications,
abstracting away the details of rendering, selection, and input behavior with a
familiar declarative API.
- Immutable Editor State: The Draft.js model is built
with immutable-js, offering
an API with functional state updates and aggressively leveraging data persistence
for scalable memory usage.

Learn how to use Draft.js in your own project.

Draft.js is used in production on Facebook, including status and
comment inputs, Notes, and
messenger.com.

API Notice


Before getting started, please be aware that we recently changed the API of
Entity storage in Draft.

Previously, the old API was set to be removed in v0.11.0. Since, the plans have changed— v0.11.0 still supports the old API and v0.12.0 will remove it. Refer to the docs for more information and information on how to migrate.

Getting Started


  1. ```
  2. npm install --save draft-js react react-dom

  4. or

  6. yarn add draft-js react react-dom
  7. ```

Draft.js depends on React and React DOM which must also be installed.

Using Draft.js


  1. ```javascript
  2. import React from 'react';
  3. import ReactDOM from 'react-dom';
  4. import {Editor, EditorState} from 'draft-js';

  6. function MyEditor() {

  8.   
  9.   constructor(props) {
  10.     super(props);
  11.     this.state = {editorState: EditorState.createEmpty()};
  12.     this.onChange = (editorState) => this.setState({editorState});
  13.     this.setEditor = (editor) => {
  14.       this.editor = editor;
  15.     };
  16.     this.focusEditor = () => {
  17.       if (this.editor) {
  18.         this.editor.focus();
  19.       }
  20.     };
  21.   }

  23.   componentDidMount() {
  24.     this.focusEditor();
  25.   }

  27.   render() {
  28.     return (
  29.       <div style={styles.editor} onClick={this.focusEditor}>
  30.         <Editor
  31.           ref={this.setEditor}
  32.           editorState={this.state.editorState}
  33.           onChange={this.onChange}
  34.         />
  35.       </div>
  36.     );
  37.   }
  38. }

  40. const styles = {
  41.   editor: {
  42.     border: '1px solid gray',
  43.     minHeight: '6em'
  44.   }
  45. };

  47. ReactDOM.render(
  48.   <MyEditor />,
  49.   document.getElementById('container')
  50. );
  51. ```

Since the release of React 16.8, you can use Hooks as a way to work withEditorState without using a class.


  1. ```js
  2. import React from "react";
  3. import { Editor, EditorState } from "draft-js";
  4. import "draft-js/dist/Draft.css";

  6. export default function MyEditor() {
  7.   const [editorState, setEditorState] = React.useState(() =>
  8.     EditorState.createEmpty()
  9.   );

  11.   const editor = React.useRef(null);
  12.   function focusEditor() {
  13.     editor.current.focus();
  14.   }

  16.   return (
  17.     <div
  18.       style={{ border: "1px solid black", minHeight: "6em", cursor: "text" }}
  19.       onClick={focusEditor}
  20.     >
  21.       <Editor
  22.         ref={editor}
  23.         editorState={editorState}
  24.         onChange={setEditorState}
  25.         placeholder="Write something!"
  26.       />
  27.     </div>
  28.   );
  29. }

  31. ```

Note that the editor itself is only as tall as its contents. In order to give users a visual cue, we recommend setting a border and a minimum height via the .DraftEditor-root CSS selector, or using a wrapper div like in the above example.

Because Draft.js supports unicode, you must have the following meta tag in the `` `` block of your HTML file:

  1. ```html
  2. <meta charset="utf-8" />
  3. ```

Further examples of how Draft.js can be used are provided in the /examples directory of this repo.

Building Draft.js


Draft.js is built with Yarn v1. Using other package managers mgiht work, but is not officially supported.

To clone and build, run:

  1. ```
  2. git clone https://github.com/facebook/draft-js.git
  3. cd draft-js
  4. yarn install
  5. yarn run build
  6. ```

Examples


To run the examples in the /examples directory, first build Draft.js locally as described above. Then, open the example HTML files in your browser.

Browser Support


![IE![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_32x32.png)![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_32x32.png)![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_32x32.png)![iOS![Chrome
------------------------------------------------------
IE11,lastlastlastnotnot

[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).

Resources and Ecosystem


Check out this curated list of articles and open-sourced projects/utilities: Awesome Draft-JS.

Discussion and Support


Join our Slack team!

Contribute


We welcome pull requests. Learn how to
contribute.

License


Draft.js is MIT licensed.

Examples provided in this repository and in the documentation are separately
licensed.