am-editor11212/plugins/bold/README.md

1007 B
Raw Permalink Blame History

@aomao/plugin-bold

加粗样式插件

安装

$ yarn add @aomao/plugin-bold

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import Bold from '@aomao/plugin-bold';

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

可选项

快捷键

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

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

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

Markdown

默认支持 markdown传入false关闭

Bold 插件 markdown 语法为**

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

命令

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