@techstacker/tse-link-plugin
v5.2.13
Published
SlateJS link node plugin.
Downloads
14
Readme
SlateJS link plugin.
Installation
The @slate-editor/link-plugin is available as an npm package.
yarn add @slate-editor/link-plugin
Usage
Here is a quick example to get you started:
import React from 'react'
import { SlateEditor, SlateToolbar, SlateContent } from 'slate-editor'
import { LinkPlugin, LinkButton } from '@slate-editor/link-plugin'
const plugins = [
LinkPlugin()
]
const SlateRichTextEditor = () => (
<SlateEditor plugins={plugins}>
<SlateToolbar>
<LinkButton />
</SlateToolbar>
<SlateContent />
</SlateEditor>
)
export default SlateRichTextEditor
Keyboard Shortcut
| OS | Shortcut | |--------------------------|-----------------------------| | | ⌘ + k | | | ^ + k |
API
| Name | Description |
|----------------------|---------------------------------------------------------------------------|
| LinkNode | Component that holds the html that will wrap the content with link. |
| LinkKeyboardShortcut | Keyboard shortcut file that manipulates onKeyDown
event inside SlateJS. |
| LinkUtils | Generic file that holds the util common functions. |
| LinkButton | Button component that have behaviour to wrap content with link. |
TODO
- Make keyboard shortcut accepts customization;
- Add behaviour to catch onPaste command and identify if it is an url and ask if wants to link it;