draft-js-richbuttons-plugin

2.2.0 • Public • Published

DraftJS RichButtons Plugin

npm version Build Status

This is a plugin for the draft-js-plugins-editor. This plugin allows you to add essential rich formatting buttons (inline and block styles) to your plugins-enabled editor.

Usage

First instantiate the plugin:

import createRichButtonsPlugin from 'draft-js-richbuttons-plugin';
 
const richButtonsPlugin = createRichButtonsPlugin();

Now get any desired components for inline or block formatting buttons from the instance:

/* import only the ones you need; all available shown */
const {    
  // inline buttons
  ItalicButton, BoldButton, MonospaceButton, UnderlineButton,
  // block buttons
  ParagraphButton, BlockquoteButton, CodeButton, OLButton, ULButton, H1Button, H2Button, H3Button, H4Button, H5Button, H6Button
= richButtonsPlugin;

Render these where desired in your component:

<div className="myToolbar">
  <BoldButton/>
  <ItalicButton/>
 
  <H2Button/>
  <ULButton/>
  <OLButton/>
</div>

Rendering Your Own Buttons

The default buttons are intentionally plain, but will pass the needed props down to their child, allowing you to customize rendering to your needs.

Props passed to both inline and block buttons:

  • isActive (bool) - true if style / blocktype active in selection
  • label (string) - default label

Props unique to inline buttons:

  • toggleInlineStyle (func) - to be attached to your click event
  • inlineStyle (string) - the draft code for the style
  • onMouseDown (func) - attach this to the onMouseDown event of your custom controls; important for preventing focus from leaving the editor when toggling an inline style with a click

Props unique to block buttons:

  • toggleBlockType (func) - to be attached to your click event
  • blockType (string) - the draft code for the block type

Example:

/*
  Stateless component for inline style buttons, using the passed props as well as a custom prop "iconName"
*/
const MyIconButton = ({iconName, toggleInlineStyle, isActive, label, inlineStyle, onMouseDown, title}) =>
  <a onClick={toggleInlineStyle} onMouseDown={onMouseDown}>
    <span
      className={`fa fa-${iconName}`}
      title={title ? title : label}
      style={{ color: isActive ? '#000' : '#777' }}
    />
  </a>;

The above presentational component could then be used this way:

<BoldButton>
  <MyIconButton iconName="bold"/>
</BoldButton>
<ItalicButton>
  <MyIconButton iconName="italic" title="Italicize" />
</ItalicButton>

Version 2.x.x

The draft-js-plugins project is approaching a v2 milestone, currently in beta. Use the 2.x branch of this repository if moving to the lastest version of that project; otherwise, 1.x is stable for the current release of draft-js-plugins.

Key Bindings

The plugin automatically applies default key bindings from draft's RichUtils, including Tab / Shift-Tab behavior for nested lists.

License

MIT

Package Sidebar

Install

npm i draft-js-richbuttons-plugin

Weekly Downloads

230

Version

2.2.0

License

MIT

Last publish

Collaborators

  • jasonphillips