@xiehy/plugin-backcolor

背景颜色插件

安装

$ yarn add @xiehy/plugin-backcolor

添加到引擎

import Engine, { EngineInterface } from '@xiehy/engine';
import Backcolor from '@xiehy/plugin-backcolor';

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

可选项

快捷键

默认无快捷键

//快捷键，key 组合键，args，执行参数，[color,defaultColor?] ， color 必须，defaultColor 可选
hotkey?:{key:string,args:Array<string>};//默认无

//使用配置
new Engine(...,{
    config:{
        "backcolor":{
            //修改快捷键
            hotkey:{
                key:"mod+b",
                args:["#000000","#ffffff"]
            }
        }
    }
 })

命令

//color：更改的背景颜色，defaultColor：保持的默认背景色，在没有传入 defaultColor 或者 color 与 defaultColor 值不同时执行背景色修改
engine.command.execute('backcolor', color, defaultColor);
//使用 command 执行查询当前状态，返回 Array<string> | undefined，当前光标所在处背景色值集合
engine.command.queryState('backcolor');