@techstacker/tse-embed-plugin
v5.2.0-alpha.273b0e7e
Published
SlateJS embed node plugin.
Downloads
3
Readme
SlateJS embed plugin.
Installation
The @slate-editor/embed-plugin is available as an npm package.
yarn add @slate-editor/embed-plugin
Usage
Here is a quick example to get you started:
import React from 'react'
import { SlateEditor, SlateToolbar, SlateContent } from 'slate-editor'
import { EmbedPlugin, EmbedButton } from '@slate-editor/embed-plugin'
const plugins = [
EmbedPlugin()
]
const SlateRichTextEditor = () => (
<SlateEditor plugins={plugins}>
<SlateToolbar>
<EmbedButton />
</SlateToolbar>
<SlateContent />
</SlateEditor>
)
export default SlateRichTextEditor
Keyboard Shortcut
| OS | Shortcut |
|--------------------------|----------|
| | ⌘
+e
|
| | ^
+e
|
API
| Name | Description |
|-----------------------|----------------------------------------------------------------------------|
| EmbedNode | Component that holds the html that will wrap the content with embed style. |
| EmbedKeyboardShortcut | Keyboard shortcut file that manipulates onKeyDown
event inside SlateJS. |
| EmbedUtils | Generic file that holds the util common functions. |
| EmbedButton | Button component that have behaviour to wrap content with embed style. |
TODO
- Make keyboard shortcut accepts customization