Skip to content

Strike

Mark text with a strikethrough while keeping the text in the document.

Setup

Start with the packages in Getting Started. This complete example registers the feature and renders its UI. In an existing editor, merge the imports and extension entries into your setup, and place the controls inside your existing RichTextProvider.

tsx
'use client';

import { EditorContent, useEditor } from '@tiptap/react';
import { Document } from '@tiptap/extension-document';
import { Paragraph } from '@tiptap/extension-paragraph';
import { Text } from '@tiptap/extension-text';
import { RichTextProvider } from 'reactjs-tiptap-editor';
import { Strike, RichTextStrike } from 'reactjs-tiptap-editor/strike';
import 'reactjs-tiptap-editor/style.css';

const extensions = [Document, Paragraph, Text, Strike];

export default function StrikeExample() {
  const editor = useEditor({
    extensions,
    content: '<p>Try this feature here.</p>',
    immediatelyRender: false,
  });

  if (!editor) return null;

  return (
    <RichTextProvider editor={editor}>
      <RichTextStrike />
      <EditorContent editor={editor} />
    </RichTextProvider>
  );
}

How to use

Select text and click the strikethrough button. Use editor.chain().focus().toggleStrike().run() from a custom control.

Options

shortcutKeys

Type: string[]
Default: ['shift', 'mod', 'S']

Shortcut labels shown by the controls. See keyboard shortcut configuration to change actual key bindings.

Source

SourceDocs

Contributors

Changelog

v1.0.0 on 12/7/2025
51948 - feat: refactor code, dynamic bubble, toolbar, fix error
v0.4.0 on 12/4/2025
6a3a7 - feat: migrate tiptap v2 to v3
v0.3.28 on 10/13/2025
20125 - feat: add shortcutKeys override(s) to extensions

Made with ❤️