https://github.com/jasonphillips/draft-js-richbuttons-plugin

A plugin for adding rich formatting controls - https://jasonphillips.github.io/draft-js-richbuttons-plugin/
https://github.com/jasonphillips/draft-js-richbuttons-plugin

Last synced: 3 months ago
JSON representation

A plugin for adding rich formatting controls - https://jasonphillips.github.io/draft-js-richbuttons-plugin/

• Host: GitHub
• URL: https://github.com/jasonphillips/draft-js-richbuttons-plugin
• Owner: jasonphillips
• Created: 2016-06-16T23:33:31.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-09-17T14:08:03.000Z (almost 3 years ago)
• Last Synced: 2024-03-22T09:08:18.309Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.19 MB
• Stars: 38
• Watchers: 3
• Forks: 14
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Lists

• awesome-draft-js - RichButtons - Add and customize rich formatting buttons. (Plugins and Decorators Built for Draft.js)
• awesome-draft-js - RichButtons - Add and customize rich formatting buttons. (Plugins and Decorators Built for Draft.js)

README

        
# DraftJS RichButtons Plugin

[![npm version](https://badge.fury.io/js/draft-js-richbuttons-plugin.svg)](http://badge.fury.io/js/draft-js-richbuttons-plugin)  [![Build Status](https://travis-ci.org/jasonphillips/draft-js-richbuttons-plugin.svg?branch=master)](https://travis-ci.org/jasonphillips/draft-js-richbuttons-plugin)  [![npm downloads](https://img.shields.io/npm/dm/draft-js-richbuttons-plugin.svg)](https://www.npmjs.com/package/draft-js-richbuttons-plugin)

*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:

```js

import createRichButtonsPlugin from 'draft-js-richbuttons-plugin';

const richButtonsPlugin = createRichButtonsPlugin();

```

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

```js

/* 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:

```HTML



  

  


  

  

  



```


## Custom Block Types or Inline Styles

Button components behaving exactly like those above can be obtained for any custom block or inline style types used in your draft instance, by invoking either `createStyleButton` or `createBlockButton`:

```js

const { createStyleButton, createBlockButton } = richButtonsPlugin;

// create a custom inlinestyle button

const RedStyleButton = createStyleButton({style: 'RED', label: 'Red'});

// create a custom block-type button

const BorderedBlockButton = createBlockButton({type: 'BorderedBox', label: 'LittleBox'}); 

```

See more complete code in the included example.

## 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:

```js

/*

  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}) =>

  

    

  ;

```

The above presentational component could then be used this way:

```html

  

  

```

## Key Bindings

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

## License

MIT