am-editor-002/docs/plugin/plugin-sup.zh-CN.md

@aomao/plugin-sup

上标样式插件

安装

$ yarn add @aomao/plugin-sup

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import Sup from '@aomao/plugin-sup';

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

可选项

快捷键

默认快捷键为 mod+.，以数组形式传入多个快捷键

//快捷键，
hotkey?: string | Array<string>;

//使用配置
new Engine(...,{
    config:{
        "sup":{
            //修改快捷键
            hotkey:"快捷键"
        }
    }
 })

Markdown

默认支持 markdown，传入false关闭

Sup 插件 markdown 语法为^

markdown?: boolean;//默认开启，false 关闭
//使用配置
new Engine(...,{
    config:{
        "sup":{
            //关闭markdown
            markdown:false
        }
    }
 })

命令

engine.command.execute('sup');
//使用 command 执行查询当前状态，返回 boolean | undefined
engine.command.queryState('sup');