# @editorjs/link-autocomplete 中文文档

规范地址：https://npmcn.com/package/%40editorjs/link-autocomplete/

版本：0\.1\.0
npm 元数据更新时间：2022-11-30T14:06:06.548Z
中文译文更新时间：2026-11-13T07:08:34.787Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40editorjs/link-autocomplete
原文对照：https://npmcn.com/package/%40editorjs/link-autocomplete/?lang=original
源码仓库：https://github.com/editor-js/link-autocomplete

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：49.8 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2021-07-21T14:46:29.506Z
- 最新版本发布：2022-11-30T14:06:06.450Z
- 近 30 天下载量：2274（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

链接编辑器的自动完整内入工具JS

## 安装

```sh
npm install @editorjs/link-autocomplete
```

也可以使用：`pnpm add @editorjs/link-autocomplete`、`yarn add @editorjs/link-autocomplete`、`bun add @editorjs/link-autocomplete`

## README

# 链接自动完成

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

![](https://npmcn.com/package/%40editorjs/link-autocomplete/example/assets/example.png)

## 安装

### 通过国家预防机制安装

拿到包裹

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

```shell
yarn add -D @editorjs/link-autocomplete
```

### 从 CDN 装入

您可以使用 jsDelivr CDN 软件包.

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

## 使用量

添加新工具到 `tools` 的属性.

```javascript
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`。 。 。 .

```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` 和其他自定义字段.

```json
{
    "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 (中文(中国大陆) )](http://opencollective.com/editorjs)

# 关于代码X

![](https://codex.so/public/app/img/codex-logo.svg)

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

| 🌐 | 加入QQ 组合 | 微博 | 内存 |
| --- | --- | --- | --- |
| [代码](https://codex.so/) | [代码. so/ join](https://codex.so/join) | [@ codex 团队](http://twitter.com/codex_team) | [@ codex 团队](http://instagram.com/codex_team) |

## 常见问题

### @editorjs/link-autocomplete 是什么？

链接编辑器的自动完整内入工具JS

### 如何安装 @editorjs/link-autocomplete？

在项目目录运行 npm install @editorjs/link-autocomplete，或使用 pnpm add / yarn add / bun add。

### @editorjs/link-autocomplete 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/editorjs\_\_link-autocomplete 是否存在。

### @editorjs/link-autocomplete 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @editorjs/link-autocomplete 可以商用吗？

@editorjs/link-autocomplete 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @editorjs/link-autocomplete 的下载量有多少？

根据 npm 官方下载统计，@editorjs/link-autocomplete 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,274 次，日均约 76 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @editorjs/link-autocomplete 还在维护吗？

最新版本 0\.1\.0 发布于 2022/11/30（3 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/07/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。