am-editor-002/docs/plugin/plugin-strikethrough.md

@aomao/plugin-strikethrough

Strikethrough style plugin

Installation

$ yarn add @aomao/plugin-strikethrough

Add to engine

import Engine, {EngineInterface} from'@aomao/engine';
import Strikethrough from'@aomao/plugin-strikethrough';

new Engine(...,{ plugins:[Strikethrough] })

Optional

hot key

The default shortcut key is mod+shift+x, and multiple shortcut keys are passed in as an array

//hot key,
hotkey?: string | Array<string>;

//Use configuration
new Engine(...,{
    config:{
        "strikethrough":{
            //Modify shortcut keys
            hotkey: "shortcut key"
        }
    }
 })

Markdown

Support markdown by default, pass in false to close

Strikethrough plugin markdown syntax is ~~

markdown?: boolean;//enabled by default, false off
//Use configuration
new Engine(...,{
    config:{
        "strikethrough":{
            //Close markdown
            markdown:false
        }
    }
 })

Command

engine.command.execute('strikethrough');
//Use command to execute query current status, return boolean | undefined
engine.command.queryState('strikethrough');