Skip to content
This repository has been archived by the owner on Sep 30, 2021. It is now read-only.

MauricioRobayo/switch-emoji

Repository files navigation

Switch Emoji 💃

No longer mantained. Consider using svg-emojis.


Semoji CI codecov CodeFactor bundlephobia

Consistent emojis across devices.

Choose your emoji flavor from Twemoji, GitHub emojis, or OpenMoji.

GitHub Twitter OpenMoji

Installation

npm install --save switch-emoji

Usage

import { Semoji } from "switch-emoji";

export function SomeComponent() {
  return <Semoji emoji="👋" source="GitHub" />;
}

You can wrap Semoji to create you own Emoji React component with your flavor of choice:

import React from "react";
import { Semoji, SemojiProps } from "switch-emoji";

type Props = Omit<SemojiProps, "source">;

export function Emoji(props: Props): JSX.Element | null {
  return <Semoji {...props} source="Twitter" />;
}

Read the documentation 📘.

TypeScript

The component is written in TypeScript and type definitions are included.

Contributing

All type of contributions are welcome!

Show your support

Give a ⭐️ if you like this project!

LICENSE

MIT

About

Consistent emojis across devices

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published