react-mui-editor

0.1.0 • Public • Published

React Material WYSIWYG Editor

A Material-UI based WYSIWYG editor for React.

  • Built using DraftJs.
  • Material UI (updated for v5) design for the editor toolbar buttons.
  • Light & Dark themes for the editor.

Light Theme: React MUI Editor Light

Dark Theme: React MUI Editor Dark

The editor is customizable, and I have already added some options to customize. If you'd like to have more customization ability, let me know by making a feature request.

Installation

The package is available via npm - react-mui-wysiwyg. To install, run the following command (You need to have node or npm or yarn installed):

// with npm
npm install react-mui-editor

// with yarn
yarn add react-mui-editor

Usage

After installation, you can just import the MaterialEditor component as follows:

import { MaterialEditor } from "react-mui-editor";

<MaterialEditor />;

See the example (App.js) in Github repo, on how to customize the editor. editorContent state variable can be used to store editor contents as html.

More details on how to customize, will be added soon.

Upcoming Features

0.1.0 Initial set of changes

Upcoming

  • Add/Remove Hyperlinks
  • Text alignment
  • Add/Remove Images

Future releases

  • Undo/Redo
  • Change default RichUtils styling
  • Text & highlight color
  • Subscript and Superscript
  • Code refactoring & bug fixes
  • New feature requests

Help/Feature requests

  • Use the Github "Discussion" section for help.
  • Bug reports or feature/enhancement requests can be made through "Issues" section.

Package Sidebar

Install

npm i react-mui-editor

Weekly Downloads

112

Version

0.1.0

License

none

Unpacked Size

37.1 kB

Total Files

14

Last publish

Collaborators

  • coolbytes.in