介绍
Gravatar 是全球认可的头像服务,许多站点都使用 Gravatar 为用户提供全球唯一的头像映射,使用方便且无需存储头像资源。npm 包 gravatar 是一个 Node.js 模块,封装了 Gravatar 头像服务,方便我们在前端应用中调用 Gravatar,无需搭建 Gravatar 服务器,也无需繁琐的 Gravatar 接口调用,我们只需要几行代码就可以绑定 Gravatar 头像到我们的项目中。
安装
使用 npm 安装 gravatar 模块:
npm install gravatar --save
使用
基本使用
使用 Gravatar 提供的 API,我们可以非常简单地实现获取头像图片的功能。以下代码通过调用 Gravatar 的 API,根据电子邮箱地址获取用户头像图片 URL,并渲染到页面上:
const gravatar = require('gravatar'); const email = 'your_email@example.com'; const imgURL = gravatar.url(email); const img = document.createElement('img'); img.src = imgURL; document.body.appendChild(img);
参数使用
gravatar 模块还提供了一套完全的参数化 API,让你可以自定义扩展 Gravatar 的特性,包括头像大小、图片类型、默认头像、头像评级等等。下面是一个例子:使用 Gravatar 的 API,根据电子邮箱地址获取用户头像图片 URL,并自定义头像参数:
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ----- - ------------------------- ----- ------- - - -- ---- -- ---- -- ----- -- -------- ----------- -- --- -- ------- --- -- - - -- ----- ------ - ------------------- --------- ----- --- - ------------------------------ ------- - ------- -------------------------------展开代码
参数说明
对于 Gravatar API 所支持的全部参数,我们可以通过 npm gravatar 文档来快速了解:
const gravatar = require('gravatar'); console.log(gravatar.profile_url('licopeng@hotmail.com', {protocol: 'https', format: 'qr'}));
这个函数将会生成下面这个 Gravatar 配置:
https://www.gravatar.com/licopeng.json?qr
其中,参数 options 详细介绍如下:
参数 | 描述 | 取值 |
---|---|---|
d | 默认头像 | 404, mm, identicon, monsterid, wavatar, retro, blank, email, https://path/to/image.jpg |
s | 尺寸,单位像素(最大值为 2048) | 0-2048 |
r | 图片评级 | g, pg, r, 和 x |
protocol | 头像的协议 | http, https |
format | 需要返回的头像格式 | url, qr, json |
结论
npm 包 gravatar 提供了非常好的 API 封装,让我们可以轻松快捷地使用 Gravatar 头像服务,而不需要关注 Gravatar 的底层实现。在前端项目中使用 Gravatar,减少了我们的代码量,让用户头像更加集中化管理,避免了冗余的头像信息储存。而且,我们也可以通过适当的参数选择,更好的控制用户头像在不同场景下的展示。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/75018