am-editor-002/plugins/italic/README.md

1.0 KiB
Raw Permalink Blame History

@aomao/plugin-italic

斜体样式插件

安装

$ yarn add @aomao/plugin-italic

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import Italic from '@aomao/plugin-italic';

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

可选项

快捷键

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

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

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

Markdown

默认支持 markdown传入false关闭

Italic 插件 markdown 语法为_

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

命令

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