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