Update readme to suggest building with yarn (#2527) (Kevin Chavez in 54213a13)
Update build, static analysis deps (+ upgrade to fbjs 2.0.0) (#2541) (Kevin Chavez in 5e92a32f)
Tex example: Update babel to v7 + other deps (#2533) (Kevin Chavez in ce94ecf3)
Update package.json (#2490) (Michaël De Boey in b79082f9)
Update media.html (#2452) (fay in a8f44b15)
Upgrade dependencies in playground example (#2534) (Kevin Chavez in f6bf4ed3)
feat(docs): Update README.md (#2523) (Darsh Shah in e0fc33eb)
adds highlight in docs (#2469) (Tunde Thomas in cef61910)
Update QuickStart-API-Basics.md (#2491) (Michaël De Boey in 170fe23a)
Update .travis.yml (#2495) (Michaël De Boey in 3eb391e7)
Update link to Record in docs (#2418) (Rounak Agarwal in 6a55c383)
Update link to Immutable Map in docs (#2530) (Rounak Agarwal in 31dde91a)
Upgrade browserify and babel deps in universal example (#2532) (Kevin Chavez in 1c8815a1)
Upgrade eslint, flow, jest (#2531) (Kevin Chavez in ccd0470b)
Fix the build by adding an argument to catch statement (Kevin Chavez in 5482c902)
Conditionally invokes URI.tryParseURI in OSS code (Claudio Procida in 36de6f1f)
formatPastedText prop (Laura González in 9a9ccbd5)
fix pasting invalid links (Frank Thompson in 862a5b2b)
chore(dependabot): adds examples directories separately (#2505) (Claudio Procida in fb0eb34c)
style(website): Removes desaturation (#2504) (Claudio Procida in 2b8edb18)
Fixes links accessibility by adding underlines (#2497) (R Nabors in 5e17cc24)
add codes to suppressions in www (Daniel Sainati in 8457ebba)
update comments in mobile to support error codes (Daniel Sainati in fb728fde)
Use object shorthand in DraftEditorCompositionHandler (Kevin Chavez in d949433d)
Force the selection when composition is resolved (#2094) (Robbert Brak in 3be4d372)
fix(security): Upgrades Docusaurus to address CVE-2020-7662 (#2457) (Claudio Procida in a08a8fa5)

Readme

Source

Draft.js

Live Demo

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.

API Notice

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.

Getting Started

npm install --save draft-js react react-dom

or

yarn add draft-js react react-dom

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

Using Draft.js

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});
    this.setEditor = (editor) => {
      this.editor = editor;
    };
    this.focusEditor = () => {
      if (this.editor) {
        this.editor.focus();
      }
    };
  }

  componentDidMount() {
    this.focusEditor();
  }

  render() {
    return (
      <div style={styles.editor} onClick={this.focusEditor}>
        <Editor
          ref={this.setEditor}
          editorState={this.state.editorState}
          onChange={this.onChange}
        />
      </div>
    );
  }
}

const styles = {
  editor: {
    border: '1px solid gray',
    minHeight: '6em'
  }
};

ReactDOM.render(
  <MyEditor />,
  document.getElementById('container')
);

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

import React from 'react';
import ReactDOM from 'react-dom';
import {Editor, EditorState} from 'draft-js';

function MyEditor() {
  const [editorState, setEditorState] = React.useState(
    EditorState.createEmpty()
  );

  const editor = React.useRef(null);

  function focusEditor() {
    editor.current.focus();
  }

  React.useEffect(() => {
    focusEditor()
  }, []);

  return (
    <div onClick={focusEditor}>
      <Editor
        ref={editor}
        editorState={editorState}
        onChange={editorState => setEditorState(editorState)}
      />
    </div>
  );
}

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 <head> </head> block of your HTML file:

<meta charset="utf-8" />

Further examples of how Draft.js can be used are provided below.

Examples

Visit http://draftjs.org/ to try out a basic 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. The Draft.js build is tested with Yarn v1 only. If you're using any other package manager and something doesn't work, try using yarn v1:

git clone https://github.com/facebook/draft-js.git
cd draft-js
yarn install
yarn 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.

Browser Support

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

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 actively 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.

Keywords

FAQs

What is draft-js?

Is draft-js popular?

Is draft-js well maintained?

Last updated on 17 Aug 2020

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.

Install

draft-js

.css-1z04cui{margin-bottom:var(--chakra-space-4);font-size:var(--chakra-fontSizes-md);}0.11.7 (Aug 13th, 2020)

Added

Changed