@github/g-emoji-element

中文文档
1.2.0发布于 2024/08/24MITTypeScriptES Module零依赖近 30 天下载 5.6万

Backports native emoji characters to browsers that don't support them by replacing the characters with fallback images.

原始使用文档
文档目录6 节
  1. Installation
  2. Usage
  3. Skin tones
  4. Browser support
  5. Development
  6. License

<g-emoji> element

Backports native emoji characters to browsers that don't support them by replacing the characters with fallback images.

Installation

$ npm install @github/g-emoji-element

Usage

import '@github/g-emoji-element'
<g-emoji fallback-src="t-rex.png" alias="T-Rex">🦖</g-emoji>

If a browser supports emoji, nothing happens. If a browser does not support emoji, a fallback image tag is created:

<g-emoji fallback-src="t-rex.png" alias="T-Rex">
  <img class="emoji" alt="T-Rex" height="20" width="20" src="t-rex.png">
</g-emoji>

Skin tones

The tone attribute renders the emoji with a skin tone modifier between 1-5. Use 0 to display the default tone.

<g-emoji tone="0">👋</g-emoji>
<g-emoji tone="1">👋🏻</g-emoji>
<g-emoji tone="2">👋🏼</g-emoji>
<g-emoji tone="3">👋🏽</g-emoji>
<g-emoji tone="4">👋🏾</g-emoji>
<g-emoji tone="5">👋🏿</g-emoji>
> const emoji = document.createElement('g-emoji')
> emoji.textContent = '👋'
> emoji.tone = '5'
> document.body.append(emoji)
> emoji.textContent
"👋🏿"

The tone attribute accepts a space separated list of skin tone modifiers to apply to each base emoji in a sequence. Some platforms will display these sequences as a single glyph while others will render each emoji in the sequence.

<g-emoji tone="4 5">🧑🏾<200d>🤝<200d>🧑🏿</g-emoji>

Browser support

Browsers without native custom element support require a polyfill.

  • Chrome
  • Firefox
  • Safari
  • Microsoft Edge

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

版本与发布记录

@github/g-emoji-element 共发布 17 个版本,首次发布于 2018/07/26;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.2.0latest2024/08/242 年前
1.1.52020/07/176 年前
1.1.42020/06/046 年前
1.1.32020/01/206 年前
1.1.22019/11/057 年前
1.1.12019/10/267 年前

关于 @github/g-emoji-element 的常见问题

@github/g-emoji-element 是什么?

Backports native emoji characters to browsers that don't support them by replacing the characters with fallback images.

如何安装 @github/g-emoji-element?

在项目目录运行 npm install @github/g-emoji-element,或使用 pnpm add / yarn add / bun add。

@github/g-emoji-element 支持 TypeScript 吗?

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

@github/g-emoji-element 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@github/g-emoji-element 可以商用吗?

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

@github/g-emoji-element 的下载量有多少?

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

@github/g-emoji-element 还在维护吗?

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