am-editor11212/docs/plugin/plugin-fontcolor.zh-CN.md

52 lines
1.1 KiB
Markdown
Raw Normal View History

2021-11-03 19:58:08 +08:00
# @aomao/plugin-fontcolor
前景色插件
## 安装
```bash
$ yarn add @aomao/plugin-fontcolor
```
添加到引擎
```ts
import Engine, { EngineInterface } from '@aomao/engine';
import Fontcolor from '@aomao/plugin-fontcolor';
new Engine(...,{ plugins:[Fontcolor] })
```
## 可选项
### 快捷键
默认无快捷键
```ts
//快捷键key 组合键args执行参数[color,defaultColor?] color 必须defaultColor 可选
hotkey?:{key:string,args:Array<string>};//默认无
//使用配置
new Engine(...,{
config:{
"fontcolor":{
//修改快捷键
hotkey:{
key:"mod+b",
args:["#000000","#ffffff"]
}
}
}
})
```
## 命令
```ts
//color更改的前景颜色defaultColor保持的默认前景色在没有传入 defaultColor 或者 color 与 defaultColor 值不同时执行前景色修改
engine.command.execute('fontcolor', color, defaultColor);
//使用 command 执行查询当前状态,返回 Array<string> | undefined当前光标所在处前景色值集合
engine.command.queryState('fontcolor');
```