@artibox/slate-strikethrough

Slate strikethrough.

Installation

npm install @artibox/slate-strikethrough --save

or

$ yarn add @artibox/slate-strikethrough

Usage

Editor

import React from 'react';
import { Strikethrough as StrikethroughIcon } from '@artibox/icons';
import { createArtiboxEditor } from '@artibox/slate-editor';
import { Toolbar } from '@artibox/slate-toolbar';
import { createStrikethrough } from '@artibox/slate-strikethrough';

const Strikethrough = createStrikethrough();

const plugins = [
  Strikethrough.forPlugin(),
  Toolbar.forPlugin({
    expandedTools: [{ icon: StrikethroughIcon, hook: Strikethrough.forToolHook() }]
  })
];

const Editor = createArtiboxEditor({
  plugins
});

export default Editor;

Jsx Serializer

import { createJsxSerializer } from '@artibox/slate-jsx-serializer';
import { createStrikethroughJsxSerializerRule } from '@artibox/slate-strikethrough';

const jsxSerializer = createJsxSerializer({
  marks: [
    createStrikethroughJsxSerializerRule()
  ]
});

...

return (
  <div>
    {jsxSerializer(valueJSON /* from slate */)}
  </div>
);

API

This package is based on based on @artibox/slate-toggle-mark.

• constants
• createStrikethrough
• createStrikethroughJsxSerializerRule

Hotkey

OS	Shortcut
	⌘+⌥+s
	ctrl+alt+s