@editorjs/personality

中文文档
2.0.2发布于 2020/09/06MITCommonJS零依赖近 30 天下载 3034

Editor.js 的个人化工具

中文使用文档
文档目录9 节
  1. 特征
  2. 拿到包裹
  3. 通过国家预防机制安装
  4. 下载到您的工程源目录
  5. 从 CDN 装入
  6. 使用量
  7. 配置参数
  8. 产出数据
  9. 后端响应格式

个性化工具

个人特性工具 编辑.js。 。 。 .

特征

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

说明 工具需要服务器侧执行来进行图像上传. 见 后端响应格式 更多细节.

拿到包裹

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

通过国家预防机制安装

拿到包裹

npm i --save-dev @editorjs/personality

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

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

下载到您的工程源目录

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

从 CDN 装入

您可以装入特定版本的软件包 jsDelivr CDN 请检查url=值 (帮助)。 。 。 .

https://cdn.jsdelivr.net/npm/@editorjs/[email protected]

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

使用量

添加新工具到 tools 的属性.

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 类型的文件,可以是 通过文件选择接受。 。 。 .
标记符string(默认 : Name名称字段的占位符
说明 占位符string(默认 : Description描述字段的占位符
链接标记符string(默认 : Link链接字段占位符

产出数据

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

外地类型说明
名称string个人姓名
说明string人物描述
链接string个人网站链接
图片string从后端上传了图像 URL .
{
    "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. 个性化工具显示已保存的图像并存储服务器答案

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

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

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

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

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

版本与发布记录

@editorjs/personality 共发布 3 个版本,首次发布于 2019/07/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.2latest2020/09/066 年前
2.0.12019/07/277 年前
2.0.02019/07/187 年前

关于 @editorjs/personality 的常见问题

@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 和提交记录判断。