@techstacker/tse-italic-plugin
v5.2.0-alpha.273b0e7e
Published
SlateJS italic mark plugin.
Downloads
4
Readme
SlateJS italic plugin.
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 |
|--------------------------|------------|
| | ⌘
+i
|
| | 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