@slate-editor/italic-plugin

SlateJS italic mark plugin.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@slate-editor/italic-plugin
259305.1.04 years ago5 years agoMinified + gzip package size for @slate-editor/italic-plugin in KB

Readme

src="https://www.psdmockups.com/wp-content/uploads/2016/07/slatejs-520x292.jpg" alt="Nossas Cidades logo" title="Nossas Cidades" height="50" />

@slate-editor/italic-plugin


SlateJS italic plugin.
npm package npm downloads

Installation

The @slate-editor/italic-plugin is available as an npm package.
yarn add @slate-editor/italic-plugin

Usage

Here is a quick example to get you started:
import React from 'react'
import { SlateEditor, SlateToolbar, SlateContent } from 'slate-editor'
import { ItalicPlugin, ItalicButton } from '@slate-editor/italic-plugin'

const plugins = [
  ItalicPlugin()
]

const SlateRichTextEditor = () => (
  <SlateEditor plugins={plugins}>
    <SlateToolbar>
      <ItalicButton />
    </SlateToolbar>

    <SlateContent />
  </SlateEditor>
)

export default SlateRichTextEditor

Keyboard Shortcut

| OS | Shortcut | |--------------------------|------------| | !Apple Logoapple | +i | | !Windows Logowindows | ctrl+i |

API

| Name | Description | |------------------------|-----------------------------------------------------------------------------| | ItalicMark | Component that holds the html that will wrap the content with italic style. | | ItalicKeyboardShortcut | Keyboard shortcut file that manipulates onKeyDown event inside SlateJS. | | ItalicUtils | Generic file that holds the util common functions. | | ItalicButton | Button component that have behaviour to wrap content with italic style. |

TODO

  • Make keyboard shortcut accepts customization