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](http://facebook.github.io/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](https://facebook.github.io/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.](https://draftjs.org/docs/getting-started/) ## 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](https://github.com/facebook/draft-js/issues/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 ```javascript 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 (

); } } const styles = { editor: { border: '1px solid gray', minHeight: '6em' } }; ReactDOM.render( , document.getElementById('container') ); ``` Since the release of React 16.8, you can use [Hooks](https://reactjs.org/docs/hooks-intro.html) as a way to work with `EditorState` without using a class. ```js 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 (

setEditorState(editorState)} />

); } ``` 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: ```html ``` 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](https://www.facebook.com/notes/), and [messenger.com](https://www.messenger.com). ## Browser Support | ![IE / Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_32x32.png)
IE / Edge | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_32x32.png)
Firefox | ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_32x32.png)
Chrome | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_32x32.png)
Safari | ![iOS Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_32x32.png)
iOS Safari | ![Chrome for Android](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_32x32.png)
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](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls/#polyfills)). [2] IME inputs have known issues in these browsers, especially Korean ([docs](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls/#ime-and-internet-explorer)). [3] There are known issues with mobile browsers, especially on Android ([docs](https://draftjs.org/docs/advanced-topics-issues-and-pitfalls/#mobile-not-yet-supported)). ## Resources and Ecosystem Check out this curated list of articles and open-sourced projects/utilities: [Awesome Draft-JS](https://github.com/nikgraf/awesome-draft-js). ## Discussion and Support Join our [Slack team](https://draftjs.herokuapp.com)! ## Contribute We actively welcome pull requests. Learn how to [contribute](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md). ## License Draft.js is [MIT licensed](https://github.com/facebook/draft-js/blob/master/LICENSE). Examples provided in this repository and in the documentation are separately licensed.

	Stars	Issues	Version	Updated	Created
ckeditor	517	6	4.12.1	5 years ago	8 years ago
cypress	46,218	1,458	13.9.0	8 days ago	10 years ago
draft-js	22,555	955	0.11.7	4 years ago	8 years ago
medium-editor	16,010	360	5.23.3	6 years ago	11 years ago
nightmare	19,513	210	3.0.2	5 years ago	10 years ago
tinymce	14,421	1,328	7.1.0	7 days ago	10 years ago

ckeditor vs cypress vs draft-js vs medium-editor vs nightmare vs tinymce

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past