# svelte-emoji

> A reusable Emoji component for Svelte applications

Latest version **1.0.2** (published 2020-01-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-01-06 |
| First published | 2019-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 25.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Sean McPherson |
| Maintainers | seanmcp |
| Keywords | svelte, emoji, a11y, accessibility, accessible |

## Links

- npm: https://www.npmjs.com/package/svelte-emoji
- Repository: https://github.com/seanmcp/svelte-emoji
- Homepage: https://github.com/seanmcp/svelte-emoji#readme
- Issues: https://github.com/seanmcp/svelte-emoji/issues
- npm.io page: https://npm.io/package/svelte-emoji

## Recent versions

- 1.0.2 (latest) — 2020-01-06
- 1.0.1 — 2020-01-02
- 1.0.0 — 2019-12-31
- 0.1.1 — 2019-12-31
- 0.1.0 — 2019-12-30
- 0.0.1-0 — 2019-12-30

## README

# svelte-emoji

[![npm](https://img.shields.io/npm/v/svelte-emoji.svg)](https://npmjs.com/package/svelte-emoji) [![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/svelte-emoji.svg)](https://npmjs.com/package/svelte-emoji) [![npm](https://img.shields.io/npm/dt/svelte-emoji.svg)](https://npmjs.com/package/svelte-emoji)

🎀 An accessible Emoji component for Svelte applications

## Why?
Emojis can add a light playfulness to your project but require some specific formatting in order to ensure they are accessible for all users. `svelte-emoji`'s reusable `Emoji` component helps you do that quickly and painlessly.

This component was ported to Svelte from [`a11y-react-emoji`](https://npm.im/a11y-react-emoji).

## Installation
Add `svelte-emoji` to your project:

```sh
npm install svelte-emoji
# or
yarn add svelte-emoji
```

## Use
Import `Emoji`, a default export, from `svelte-emoji` and add it to your code:

```jsx
<script>
    import Emoji from `svelte-emoji`
</script>

<footer>
    Made with
    {' '}
    <Emoji symbol="💕" label="love" />
    {' '}
    by Sean McPherson
</footer>
```

## Emoji component
The `Emoji` component consumes two props: `symbol` and `label`. Every other prop is spread to the top-level `<span>` element.

## License

[MIT](/LICENSE)

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