draft-js - 一个用于构建文本编辑器React框架

网友投稿 2778 2022-10-30

draft-js - 一个用于构建文本编辑器React框架

draft-js - 一个用于构建文本编辑器React框架

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

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-domoryarn add draft-js react react-dom

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 (

); }}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 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 (

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:

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:

git clone https://github.com/facebook/draft-js.gitcd draft-jsnpm installnpm 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

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

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。

标签：js
上一篇:SmartGo 一个更简单的方法来启动框架组件
下一篇:基础知识：字符串
相关文章

 发表评论

暂时没有评论，来抢沙发吧~