An open API service indexing awesome lists of open source software.

https://github.com/devhau/react-wysiwyg-draft


https://github.com/devhau/react-wysiwyg-draft

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# React Wysiwyg Draft

A Wysiwyg editor built using ReactJS and DraftJS libraries.
[Demo Page](https://devhau.github.io/react-wysiwyg-draft).

[![Build Status](https://travis-ci.org/devhau/react-wysiwyg-draft.svg?branch=master)](https://travis-ci.org/devhau/react-wysiwyg-draft)

![](http://i.imgur.com/tU7kJ6i.gif)

## Features

- Configurable toolbar with option to add/remove controls.
- Option to change the order of the controls in the toolbar.
- Option to add custom controls to the toolbar.
- Option to change styles and icons in the toolbar.
- Option to show toolbar only when editor is focused.
- Support for inline styles: Bold, Italic, Underline, StrikeThrough, Code, Subscript, Superscript.
- Support for block types: Paragraph, H1 - H6, Blockquote, Code.
- Support for setting font-size and font-family.
- Support for ordered / unordered lists and indenting.
- Support for text-alignment.
- Support for coloring text or background.
- Support for adding / editing links
- Choice of more than 150 emojis.
- Support for mentions.
- Support for hashtags.
- Support for adding / uploading images.
- Support for aligning images, setting height, width.
- Support for Embedded links, flexibility to set height and width.
- Option provided to remove added styling.
- Option of undo and redo.
- Configurable behavior for RTL and Spellcheck.
- Support for placeholder.
- Support for WAI-ARIA Support attributes
- Using editor as controlled or un-controlled React component.
- Support to convert Editor Content to HTML, JSON, Markdown.
- Support to convert the HTML generated by the editor back to editor content.
- Support for internationalization.

## Installing

The package can be installed from npm `react-wysiwyg-draft`

```
$ npm install --save react-wysiwyg-draft draft-js
```

## Getting started

Editor can be used as simple React Component:

```js
import { Editor } from "react-wysiwyg-draft";
import "react-wysiwyg-draft/dist/react-wysiwyg-draft.css";
;
```

## Docs

For more documentation check [here](https://devhau.github.io/react-wysiwyg-draft/#/docs?_k=jjqinp).

## Questions Discussions

For discussions join public channel #rd_wysiwyg in [DraftJS Slack Organization](https://draftjs.herokuapp.com/).

## Fund

You can fund project at [Patreon](https://www.patreon.com/devhau).

## Thanks

Original motivation and sponsorship for this work came from [iPaoo](http://www.ipaoo.com/). I am thankful to them for allowing the Editor to be open-sourced.

## License

MIT.