Skip to main content

StrikeExtension

Summary

The extension for adding strike-through marks to the editor.

Usage

Installation

This extension is installed for you when you install the main remirror package.

You can use the imports in the following way:

import { StrikeExtension } from 'remirror/extensions';

The extension is provided by the @remirror/extension-strike package.

Examples

Source code
import 'remirror/styles/all.css';
import './styles.css';

import { cx, htmlToProsemirrorNode } from 'remirror';
import { StrikeExtension } from 'remirror/extensions';
import { Remirror, ThemeProvider, useActive, useCommands, useRemirror } from '@remirror/react';

const extensions = () => [new StrikeExtension()];

const StrikeButton = () => {
const commands = useCommands();
const active = useActive(true);
return (
<button
onMouseDown={(event) => event.preventDefault()}
onClick={() => commands.toggleStrike()}
className={cx(active.strike() && 'active')}
>
Strike
</button>
);
};

const Basic = (): JSX.Element => {
const { manager, state, onChange } = useRemirror({
extensions: extensions,
content: '<p>Text in <strike>strike</strike></p>',
stringHandler: htmlToProsemirrorNode,
});

return (
<ThemeProvider>
<Remirror
manager={manager}
autoFocus
onChange={onChange}
initialContent={state}
autoRender='end'
>
<StrikeButton />
</Remirror>
</ThemeProvider>
);
};

export default Basic;

API