# @editorjs/personality 中文文档

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

版本：2\.0\.2
npm 元数据更新时间：2022-04-05T06:42:31.249Z
中文译文更新时间：2026-11-13T07:08:28.914Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：41 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2019-07-17T18:31:23.867Z
- 最新版本发布：2020-09-06T13:12:01.539Z
- 近 30 天下载量：3034（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

Editor.js 的个人化工具

## 安装

```sh
npm install @editorjs/personality
```

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

## README

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

# 个性化工具

个人特性工具 [编辑.js](https://editorjs.io/)。 。 。 .

![](https://capella.pics/064afd7b-b67e-482b-b92a-d445b098def2.jpg)

## 特征

此工具允许您在文章中创建个性块 .

**说明** 工具需要服务器侧执行来进行图像上传. 见 [后端响应格式](https://npmcn.com/package/%40editorjs/personality/#readme-server-format) 更多细节.

## 拿到包裹

你可以用这些方法得到包裹.

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

拿到包裹

```shell
npm i --save-dev @editorjs/personality
```

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

```javascript
const Personality = require('@editorjs/personality');
```

### 下载到您的工程源目录

1.  上传文件夹 `dist` 从仓库
2.  添加 `dist/bundle.js` 文档到您的页面.

### 从 CDN 装入

您可以装入特定版本的软件包 [jsDelivr CDN 请检查url=值 (帮助)](https://cdn.jsdelivr.net/npm/@editorjs/personality@2.0.0)。 。 。 .

`https://cdn.jsdelivr.net/npm/@editorjs/personality@2.0.0`

然后在页面上要求使用 Editor.js 通过 `<script src=""></script>` 标签.

## 使用量

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

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

  tools: {
    ...
    personality: {
      class: Personality,
      config: {
        endpoint: 'http://localhost:8008/uploadFile'  // Your backend file uploader endpoint
      }
    }
  }

  ...
});
```

## 配置参数

个性工具支持这些配置参数 :

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 结束点 | `string` | **需求** 图片上传的终点 . |
| 字段 | `string` | (默认 : `image`) POST 请求中上传的图像字段名称 |
| 类型 | `string` | (默认 : `image/*`) MIME 类型的文件,可以是 [通过文件选择接受](https://github.com/codex-team/ajax#accept-string)。 。 。 . |
| 标记符 | `string` | (默认 : `Name`名称字段的占位符 |
| 说明 占位符 | `string` | (默认 : `Description`描述字段的占位符 |
| 链接标记符 | `string` | (默认 : `Link`链接字段占位符 |

## 产出数据

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

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 名称 | `string` | 个人姓名 |
| 说明 | `string` | 人物描述 |
| 链接 | `string` | 个人网站链接 |
| 图片 | `string` | 从后端上传了图像 URL . |

```json
{
    "type" : "personality",
    "data" : {
        "name" : "Elon Musk",
        "description" : "Elon Reeve Musk FRS is a technology entrepreneur, investor, and engineer. He holds South African, Canadian, and U.S. citizenship and is the founder",
        "link" : "https://twitter.com/elonmusk",
        "photo" : "https://capella.pics/3c0e1b97-bc56-4961-b54e-2a6c2c3260f2.jpg"
    }
}
```

## 后端响应格式

此工具用于从设备上传文件

**设想:**

1.  用户从设备中选择文件
2.  工具发送到 **** 后端( 打开) `config.endpoint.byFile` 路线)
3.  您的后端应该以指定格式保存文件并返回 JSON 文件数据 .
4.  个性化工具显示已保存的图像并存储服务器答案

因此,您可以通过自己的方式执行文件保存的后端. 这是一个具体和无关紧要的任务 取决于你 环境与堆栈.

您的上传器的反应 **应** 包含以下格式:

```json5
{
    "success" : 1,
    "file": {
        "url" : "https://capella.pics/3c0e1b97-bc56-4961-b54e-2a6c2c3260f2.jpg"
    }
}
```

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

**文件** - 上传的文件数据. **必须** 包含一个 `url` 字段,有完整上传图像的公开路径.

## 常见问题

### @editorjs/personality 是什么？

Editor\.js 的个人化工具

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

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

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

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

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

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

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

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

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

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

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

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