# emoji-images

> Replace stuff like :smiley: in text with tags of a corresponding image.

Latest version **0.1.1** (published 2013-09-30) · 0 weekly downloads

## Install

```sh
npm install emoji-images
pnpm add emoji-images
yarn add emoji-images
bun add emoji-images
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2013-09-30 |
| First published | 2013-03-31 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 172 |
| Author | Henrik Joreteg |
| Maintainers | henrikjoreteg |

## Links

- npm: https://www.npmjs.com/package/emoji-images
- Repository: git@github.com:henrikjoreteg/emoji-images.js
- npm.io page: https://npm.io/package/emoji-images

## Recent versions

- 0.1.1 (latest) — 2013-09-30
- 0.1.0 — 2013-07-03
- 0.0.2 — 2013-03-31
- 0.0.1 — 2013-03-31

## README

#emoji-images.js

Because sometimes you want to send a :heart: to someone.


## What is this?

Takes text, replaces all the texts here: http://www.emoji-cheat-sheet.com with an `<img>` tag containing the image.

The images are all in the [](pngs) folder. Host those somewhere, pass the URL to the function. See below:


## How to use it

```js

var string = 'a string containing emoji strings like :heart: and :trollface:';

// the emoji function takes:
// 1. The input string
// 2. The url where the png files live
// 3. (optionally) a size to specify as the height of the <img> tag.
var emojified = emoji(string, 'http://url.com/where-you-put-the-pngs-folder/', 30); 

```

It's bundled to work as a CommonJS module, AMD module or expose itself as a global as a fallback.

## install

Grab it here or on npm:

```
npm install emoji-images
```

## Why not just use https://github.com/hassankhan/emojify.js?

I want it all in a super simple text processing (without the CSS and DOM stuff).

Also, that solution embeds pngs as data-uri's in css documents. I don't want to do that because then I have to send all that image data to the browser even if they never get used.


## Is it ready to use?

Um... works for me™  (and in use on andbang.com)


## License

MIT

---
_Source: https://npm.io/package/emoji-images · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._