Skip to content
notectl

Strikethrough Plugin

The StrikethroughPlugin adds strikethrough text support with a toggle command and keyboard shortcut.

Text formatting with strikethrough

Usage

Section titled “Usage”
import { StrikethroughPlugin } from '@notectl/core/plugins/strikethrough';


new StrikethroughPlugin()

Configuration

Section titled “Configuration”
interface StrikethroughConfig {
  /** Custom locale strings. */
  readonly locale?: StrikethroughLocale;
}

Commands

Section titled “Commands”
Command Description Returns
toggleStrikethrough Toggle strikethrough mark on selection boolean 
editor.executeCommand('toggleStrikethrough');

Keyboard Shortcuts

Section titled “Keyboard Shortcuts”
Shortcut Action
Ctrl+Shift+X / Cmd+Shift+X Toggle strikethrough

Mark Spec

Section titled “Mark Spec”
Mark HTML Tag Rank
strikethrough <s> 3

Toolbar

Section titled “Toolbar”

The strikethrough button renders in the toolbar with an isActive check. When the cursor is inside strikethrough text, the button appears highlighted/pressed.