1
mirror of https://github.com/jakejarvis/imagemoji.git synced 2025-04-26 12:28:27 -04:00
2021-11-10 10:38:58 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:38:58 -05:00
2021-11-10 10:18:31 -05:00
2021-11-10 10:18:31 -05:00

🖼️ imagemoji

CI npm MIT License

Replaces emojis in strings or DOM nodes with corresponding images of your choosing. A barebones, mostly drop-in replacement for Twemoji's twemoji.parse() (and heavily cherry-picked from Twitter's original script) to cut some cruft and save a few bytes.

Usage

via unpkg:

<html>
<body>
  <p>I ❤️ emoji!</p>

  <script src="https://unpkg.com/imagemoji/dist/imagemoji.min.js"></script>
  <script>
    imagemoji.parse(document.body);
    //=> <p>I <img class="emoji" draggable="false" alt="❤️" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg"/> emoji!</p>

    imagemoji.parse(document.body, (icon) => `/assets/emoji/${icon}.png`);
    //=> <p>I <img class="emoji" draggable="false" alt="❤️" src="/assets/emoji/2764.png"/> emoji!</p>
  </script>
</body>
</html>

via NPM:

npm install imagemoji or yarn add imagemoji

import imagemoji from "imagemoji";
// or:
// const imagemoji = require("imagemoji");

imagemoji.parse(document.body);
imagemoji.parse(document.body, (icon) => `/assets/emoji/${icon}.png`);

API

.parse(what, how?)

what

Type: string or Node

Either a plain string or a DOM node (e.g. document.body) containing emojis to replace with <img>s.

how

Type: function
Default: (icon: string): string => "https://twemoji.maxcdn.com/v/latest/svg/" + icon + ".svg"

A callback function to determine the image source URL of a given emoji codepoint (always lowercase, e.g. 1f4a9 for 💩, and variations are joined with dashes, e.g. 1f468-200d-1f4bb for 👨‍💻). Defaults to pulling SVGs from the Twemoji CDN.

License

MIT

Description
🖼️ Replaces emojis in strings or DOM nodes with corresponding images
Readme MIT 509 KiB
Languages
TypeScript 100%