# @editorjs/link 中文文档

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

版本：2\.6\.2
npm 元数据更新时间：2023-11-09T19:04:52.091Z
中文译文更新时间：2026-11-13T07:07:54.058Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：82 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2019-03-02T15:28:49.748Z
- 最新版本发布：2023-11-09T19:04:51.916Z
- 近 30 天下载量：222514（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

Editor.js 的链接工具

## 安装

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

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

## README

![](https://badgen.net/badge/Editor.js/v2.0/blue)

# 链接工具

链接块 [编辑.js](https://codex.so/editor)。 。 。 .

![](https://npmcn.com/package/%40editorjs/link/assets/gif/demo.gif)

## 特征

允许在文章中添加链接预览 .

**说明:** 此工具需要服务器侧执行来获取链接数据 。 见 [后端响应格式](https://npmcn.com/package/%40editorjs/link/#readme-server-format) 更多细节.

## 安装

拿到包裹

```shell
yarn add @editorjs/link
```

在您的应用程序中包含模块

```javascript
import LinkTool from '@editorjs/link';
```

您可以选择从 CDN 装入此工具 [JsDelivr CDN (英语)](https://cdn.jsdelivr.net/npm/@editorjs/link@latest)

## 使用量

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

```javascript
const editor = EditorJS({
  ...

  tools: {
    ...
    linkTool: {
      class: LinkTool,
      config: {
        endpoint: 'http://localhost:8008/fetchUrl', // Your backend endpoint for url data fetching,
      }
    }
  },

  ...
});
```

## 配置参数

链接工具支持这些配置参数 :

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 结束点 | `string` | **要求 :** 链接数据获取的终点. |
| 页眉 | `object` | **可选 :** 在 GET 请求中所使用的信头 . |

## 产出数据

此工具返回 `data` 采用以下格式

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 链接 | `string` | 粘贴链接的 URL |
| 元数据a | `object` | 已获取链接的数据 。 任何数据都来自后端. 目前,插件的设计支持"标题","图像"和"描述"字段. |

```json
{
    "type" : "linkTool",
    "data" : {
        "link" : "https://codex.so",
        "meta" : {
            "title" : "CodeX Team",
            "site_name" : "CodeX",
            "description" : "Club of web-development, design and marketing. We build team learning how to build full-valued projects on the world market.",
            "image" : {
                "url" : "https://codex.so/public/app/img/meta_img.png"
            }
        }
    }
}
```

## 后端响应格式

您可以对获取自己方式的链接数据实施后端。 这是一个具体和无关紧要的任务 取决于你 环境与堆栈.

后端响应 **应** 包含以下格式:

```json5
{
    "success" : 1,
    "link": "https://codex.so", // Optionally return a link to set the hyperlink URL
    "meta": {
        // ... any fields you want
    }
}
```

**成功** ——上传状态. 1个成功, 0个失败

**链接** - 可选响应参数,以覆盖所提供的 URL

**元数据a** 链接获取的数据.

目前,插件的设计支持"标题","图像"和"描述"字段. 答复中应采用以下形式:

```json5
{
    "success" : 1,
    "meta": {
        "title" : "CodeX Team",
        "description" : "Club of web-development, design and marketing. We build team learning how to build full-valued projects on the world market.",
        "image" : {
            "url" : "https://codex.so/public/app/img/meta_img.png"
        }
    }
}
```

另外,它还可以包含任何您想要存储的额外字段 .

# 关于代码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 是什么？

Editor\.js 的链接工具

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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