@artibox/slate-highlight
v1.2.0
Published
<div align="center"> <img src="https://raw.githubusercontent.com/ianstormtaylor/slate/master/docs/images/banner.png" height="200" /> </div>
Downloads
33
Readme
Slate highlight.
Installation
npm install @artibox/slate-highlight --save
or
$ yarn add @artibox/slate-highlight
Usage
Editor
import React from 'react';
import { Highlight as HighlightIcon } from '@artibox/icons';
import { createArtiboxEditor } from '@artibox/slate-editor';
import { Toolbar } from '@artibox/slate-toolbar';
import { createHighlight } from '@artibox/slate-highlight';
const Highlight = createHighlight();
const plugins = [
Highlight.forPlugin(),
Toolbar.forPlugin({
expandedTools: [{ icon: HighlightIcon, hook: Highlight.forToolHook() }]
})
];
const Editor = createArtiboxEditor({
plugins
});
export default Editor;
Jsx Serializer
import { createJsxSerializer } from '@artibox/slate-jsx-serializer';
import { createHighlightJsxSerializerRule } from '@artibox/slate-highlight';
const jsxSerializer = createJsxSerializer({
marks: [
createHighlightJsxSerializerRule()
]
});
...
return (
<div>
{jsxSerializer(valueJSON /* from slate */)}
</div>
);
API
This package is based on based on @artibox/slate-toggle-mark.
Hotkey
| OS | Shortcut | | ------------------------ | ---------------------------- | | | ⌘+h | | | ctrl+h |