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

@aomao/plugin-underline

Underline style plugin

Installation

$ yarn add @aomao/plugin-underline

Add to engine

import Engine, {EngineInterface} from'@aomao/engine';
import Underline from'@aomao/plugin-underline';

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

Optional

hot key

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

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

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

Command

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