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

@aomao/plugin-link

链接插件

安装

$ yarn add @aomao/plugin-link

Vue3 使用

$ yarn add @aomao/plugin-link-vue

Vue2 使用

$ yarn add am-editor-link-vue2

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import Link from '@aomao/plugin-link';

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

可选项

快捷键

默认快捷键为 mod+k，默认参数为 ["_blank"]

//快捷键，key 组合键，args，执行参数，[target?:string,href?:string,text?:string] 打开模式：可选，默认链接：可选，默认文本：可选
hotkey?:string | {key:string,args:Array<string>};

//使用配置
new Engine(...,{
    config:{
        "link":{
            //修改快捷键
            hotkey:{
                key:"mod+k",
                args:["_balnk_","https://www.aomao.com","ITELLYOU"]
            }
        }
    }
 })

Markdown

默认支持 markdown，传入false关闭

Link 插件 markdown 语法为[文本](链接地址) 回车后触发

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

onConfirm

可对要修改的 url 或者 文本 进行修改

在编辑文本和 url 后确认执行

onConfirm?: (
    text: string,
    link: string,
) => Promise<{ text: string; link: string }>;

命令

可传入三个参数[target?:string,href?:string,text?:string] 打开模式：可选，默认链接：可选，默认文本：可选

//target:'_blank', '_parent', '_top', '_self'，href:链接，text:文字
engine.command.execute('link', '_blank', 'https://www.aomao.com', 'ITELLYOU');
//使用 command 执行查询当前状态，返回 boolean | undefined
engine.command.queryState('link');