链接自动完成

与服务器搜索的碱性内线链接工具的升级版本 .

安装

通过国家预防机制安装

拿到包裹

npm i --save-dev @editorjs/link-autocomplete

yarn add -D @editorjs/link-autocomplete

从 CDN 装入

您可以使用 jsDelivr CDN 软件包.

<script src="https://cdn.jsdelivr.net/npm/@editorjs/link-autocomplete"></script>

使用量

添加新工具到 tools 的属性.

var editor = EditorJS({
  ...
 
  /**
   * Tools list
   */
  tools: {
    link: {
      class: LinkAutocomplete,
      config: {
        endpoint: 'http://localhost:3000/',
        queryParam: 'search'
      }
    }
  },
  
  ...
});

配置参数

搜索请求将被发送到服务器 GET 作为查询参数的搜索字符串请求.

可能配置的服务器连接参数列表 .

endpoint ——服务器获取建议端点的URL.

queryParam ——要随搜索字符串发送的参数名.

如果没有 endpoint 然后工具将只对被粘贴的链接有效.

服务器响应数据格式

对于端点请求服务器 应 使用包含以下属性的 JSON 回答 :

• success (单位:千美元)boolean——加工状况: true 或者说 false
• items (单位:千美元){name: string, href: string, description?: string})——一系列已发现的项目. 每个项目 必须 包含 name 财务报告和审定财务报表 href 参数。 这个 description 参数是可选的。 您也可以返回将存储在链接数据集中的任何其他字段.

内容- 类型 : application/json。 。 。 .

{
  "success": true,
  "items": [
    {
      "href": "https://codex.so/editor",
      "name": "The first item",
      "description": ""
    },
    {
      "href": "https://codex.so/media",
      "name": "The second item",
      "description": ""
    }
  ]
}

产出数据

标记的文字将用 a 标记为通常链接.

额外数据将存储在元素的数据集中: data-name, (中文(简体) ), data-description 和其他自定义字段.

{
    "type" : "text",
    "data" : {
        "text" : "Create a directory for your module, enter it and run <a href=\"https://codex.so/\" data-name=\"CodeX Site\">npm init</a> command."
    }
}

快捷键

默认快捷键 CMD (CTRL) + K 用于粘贴链接.

I18n 时

有几句话要翻译.

用户界面项目 :

• Paste or search ——如果服务器端点通过,输入字段的占位符 .
• Paste a link —— 如果服务器端点缺失, 同一字段的占位符 .

错误消息 :

• Cannot process search request because of ——在通知中错误的文本前发出消息,以表示服务器响应不良.
• Server responded with invalid data ——服务器反应不良
• Link URL is invalid - 粘贴链接 url 不好

i18n: {
  messages: {
    tools: {
      LinkAutocomplete: {
        'Paste or search': '...',
        'Paste a link': '...',
        'Cannot process search request because of': '...',
        'Server responded with invalid data': '...',
        'Link URL is invalid': '...'
      }
    }
  }
},

支助维修

如果你在你的生意中使用了这个工具和编辑器.js,请考虑支持它们的维护和演化.

http://opencollection.com/editorjs (中文(中国大陆) )

关于代码X

CodeX是一个由全球数字专家组成的团队,他们有兴趣在全球市场上建立高质量的开源产品. 我们是 打开 帮助那些希望不断提高技能并专业地发展领导技术的年轻人.