@gravatar-com/quick-editor

中文文档
0.8.0发布于 2025/03/24GPL-2.0-or-laterTypeScriptESM + CJS零依赖近 30 天下载 3.3万

轻量级库,为第三方网站提供无缝重力配置管理

中文使用文档
文档目录13 节
  1. 特征
  2. 安装
  3. 用国家防范机制或Yarn安装
  4. 用 UNPKG 安装
  5. 使用量
  6. 重力卡塔尔快编辑器
  7. 重力卡塔尔快编辑器
  8. API 密码
  9. Gravatar 快速编辑器 API
  10. 重力卡塔尔快编辑器Core API
  11. 有效范围值
  12. 贡献给 Gravatar 快速编辑器
  13. 许可证

Gravatar 快速编辑器

Gravatar Quick Editor是一个JavaScript库,允许用户将Gravatar Quick Editor整合到他们的网络应用中,通过弹出窗口方便地编辑Gravatar的配置. 图书馆既提供高级控制的核心类,也提供快速设置的简化类.

特征

  • 与您的网络应用程序简单整合 .
  • 高级使用的核心功能.
  • 简化了快速整合的设置.
  • 支持使用PostMessage API实时更新Avatar图像.
  • TypeScript支持类型完成和验证.

安装

用国家防范机制或Yarn安装

使用 npm 或纱线安装软件包 :

npm install @gravatar-com/quick-editor
yarn add @gravatar-com/quick-editor

用 UNPKG 安装

导入库如下:

<!-- Import the library -->
<script src="https://unpkg.com/@gravatar-com/[email protected]" defer></script>

<script>
  // The library is accessible as a global variable
  console.log( Gravatar );
</script>

替换 x.x.x 带有最新版本编号。 请参看UNPKG的 文档 更多信息.

使用量

重力卡塔尔快编辑器

这个 GravatarQuickEditor class通过自动设置事件处理器来简化设置过程来打开弹出并更新页面上的avatar元素.

示例

import { GravatarQuickEditor } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  new GravatarQuickEditor( {
    email: '[email protected]',
    editorTriggerSelector: '#edit-profile',
    avatarSelector: '#gravatar-avatar',
    scope: [ 'avatars' ],
  } );
} );

重力卡塔尔快编辑器

这个 GravatarQuickEditorCore class提供了对Gravatar快编辑器功能的高级控制,允许开发者触发弹出事件并设置配置更新回调.

核心示例

import { GravatarQuickEditorCore } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  const quickEditorCore = new GravatarQuickEditorCore( {
    email: '[email protected]',
    scope: [ 'avatars', 'about' ],
    onProfileUpdated: () => {
      console.log( 'Profile updated!' );
    },
    onOpened: () => {
      console.log( 'Editor opened!' );
    },
  } );

  document.getElementById( 'edit-profile' ).addEventListener( 'click', () => {
    quickEditorCore.open();
  } );
} );

API 密码

Gravatar 快速编辑器 API

new GravatarQuickEditor(options: QuickEditorOptions);

快速编辑器选项类型

type QuickEditorOptions = {
  email: string;
  editorTriggerSelector: string;
  avatarSelector?: string;
  scope?: Scope;
  locale?: string;
  avatarRefreshDelay?: number;
};
  • email: string数字 : 与 Gravatar 配置相关的电子邮件地址 。 用于识别要编辑的配置文件 .

  • editorTriggerSelector: string数字 : HTML 元素(如按钮)的 CSS 选择器会触发Gravatar快速编辑器弹出器的打开.

  • avatarSelector: string数字 : 显示 Gravatar 的 HTML 图像元素的 CSS 选择器 。 当图像更新时,图像会自动被刷新.

  • scope: Scope数字 : 指定在弹出时可以编辑配置文件的哪些部分的数组 。 检查 有效范围值列表

  • locale: string数字 : Gravatar 编辑器接口的语言设置 。 这可用于设置编辑器UI的语言.

  • avatarRefreshDelay: number数字 : Avatar 图像之前的毫秒延迟在更新后被刷新. 这可以帮助确保任何缓存在显示新图像之前被破解.

  • utm: string数字 : 用于确定快编辑器使用地的代码.

在更新可视化图像时,为绕过浏览器缓存,快编辑器会添加一个 t 参数中含有当前时间戳到avatar URL.

重力卡塔尔快编辑器Core API

new GravatarQuickEditorCore(options: QuickEditorCoreOptions);

快速编辑器选择类型

type QuickEditorCoreOptions = Partial< {
  email: string;
  scope: Scope;
  locale: string;
  onProfileUpdated: OnProfileUpdated;
  onOpened: OnOpened;
} >;
  • email: string数字 : 与 Gravatar 配置相关的电子邮件地址 。 用于识别要编辑的配置文件 .

  • scope: Scope数字 : 指定在弹出时可以编辑配置文件的哪些部分的数组 。 检查 有效范围值列表

  • locale: string数字 : Gravatar 编辑器接口的语言设置 。 这可用于设置编辑器UI的语言.

  • onProfileUpdated: ( type: ProfileUpdatedType ) => void数字 : 当配置更新时调用回调函数 。 当用户保存其配置文件的更改时,这可用于触发应用程序中的附加动作. 它会收到一个类型参数 ProfileUpdatedType 具有以下一种值: 'avatar_updated' | 'profile_updated'

  • onOpened: () => void数字 : 一个在编辑器弹出时被调用的回调功能. 当弹出时,这可用于记录,分析或其他动作.

  • onClosed: () => void数字 : 一个在编辑器弹出后被调用的回调功能.

公职

  • open: ( email?: string ) => boolean: 触发Gravatar快速编辑器弹出功能. 它可以接收一个电子邮件地址来识别要编辑的配置文件. true 如果成功打开,则返回, false 否则.
  • close: () => void: 关闭打开的Gravatar快编辑器弹出.
  • isOpen: () => boolean编号: 返回 true 如果弹出是打开的, false 否则.

有效范围值

  • about
  • avatars
  • verified-accounts
  • links
  • interests
  • contact-info
  • wallet
  • photos
  • design
  • privacy

贡献给 Gravatar 快速编辑器

我们欢迎为这一项目提供捐款。 请遵循本报告概述的准则 捐款额 文档.

许可证

Gravatar Hovercards公司根据下列规定获得许可证: GNU 通用公共许可证 v2( 或以后)。 。 。 .

版本与发布记录

@gravatar-com/quick-editor 共发布 6 个版本,首次发布于 2024/07/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.0latest2025/03/241.6 年前
0.7.02025/03/121.7 年前
0.6.02024/08/102 年前
0.5.02024/07/062 年前
0.0.22024/07/032 年前
0.0.12024/07/022 年前

关于 @gravatar-com/quick-editor 的常见问题

@gravatar-com/quick-editor 是什么?

轻量级库,为第三方网站提供无缝重力配置管理

如何安装 @gravatar-com/quick-editor?

在项目目录运行 npm install @gravatar-com/quick-editor,或使用 pnpm add / yarn add / bun add。

@gravatar-com/quick-editor 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gravatar-com/quick-editor 支持 ESM 还是 CommonJS?

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

@gravatar-com/quick-editor 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gravatar-com/quick-editor 可以商用吗?

@gravatar-com/quick-editor 使用 GPL-2.0-or-later 许可。强 Copyleft:分发包含该代码的软件时,整个作品需以兼容的 GPL 许可开源。仅在内部使用、不对外分发时不触发此义务。以上为概括,不构成法律意见,请以许可原文为准。

@gravatar-com/quick-editor 的下载量有多少?

根据 npm 官方下载统计,@gravatar-com/quick-editor 在 2026/10/17 – 2026/11/15 这 30 天内被下载 33,495 次,日均约 1,117 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gravatar-com/quick-editor 还在维护吗?

最新版本 0.8.0 发布于 2025/03/24(1.6 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/07/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。