spatie / emoji

Programatically work with emoji characters

Programatically work with emoji characters

In PHP, you can display emoji characters just by typing them:

echo "😃";

This package provides some functionality to work with emojis if your IDE or used font can't render them correctly:

Emoji::grinningFace();

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Install

You can install the package via composer:

composer require spatie/emoji

Usage

The Spatie\Emoji\Emoji-class contains character constants that may be used directly:

Emoji::CHARACTER_GRINNING_FACE;

Or you can use the shorter method by leaving off "character" and using camelCase:

Emoji::grinningFace();

If you want to get an array containing all emojis, you can use this method:

Emoji::all();

You can also use an ISO 3166 Alpha2 country code and get the appropriate flag for the country:

Emoji::countryFlag('be'); // 🇧🇪

This package contains Full Emoji List v13.1 based on https://unicode.org/Public/emoji/13.1/emoji-test.txt all methods and constants are auto-generated.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

We are accepting PRs that add characters to the class. Please use this list to look up the unicode value and the name of the character.

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.

Credits

• Freek Van der Herten
• BoGnY
• All Contributors

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.

emoji's Issues

Laravel 8 Support

It would be great if this package update its support to Laravel 8!

upgrade to emoji v12

https://unicode.org/Public/emoji/12.0/emoji-test.txt
Using the generator #32 it should be easy to upgrade to Unicode Emoji v12 - but to make this work #32 should be merged.

Flags in Chrome

It seems that flag emojis are not showing in Chrome (using 86.0.4240.198). Firefox is ok.

Euro
{!! \Spatie\Emoji\Emoji::countryFlag('be') !!}
{!! \Spatie\Emoji\Emoji::grinningFace() !!}

What could be the reason? Am I missing something?

Method names starting with a number are invalid

/**
 * @method static string 1stPlaceMedal()
 * @method static string 2ndPlaceMedal()
 * @method static string 3rdPlaceMedal()
 */

They should be converted to first, second, third or prefixed with anything.

Is spatie/emoji dependable from other packages/fonts/Browsers of the OS?

Hello,
I installed spatie/emoji into my laravel 8 app on my local Kubuntu 18 and wonder if these emojis
are dependable from other packages/fonts/Browsers of the OS?

I found a hint that I need fonts-noto-color-emoji to be installed in the OS...

Thanks!

Flag emoji incorrect code points

http://unicode.org/emoji/charts/full-emoji-list.html
http://unicode.org/emoji/charts/index.html#col-code

Some rows have more than one codepoint where a sequence is required, such as for flags and keycaps.

echo Emoji::flagForBelgium();

So the previous code doesn't display the flag correctly, as it stores just the first codepoint for the flag U+1F1E7, that applies for all flags and keycaps. Any planned fix?

Calling for Emoji Dynamically

I am using Laravel 8 and attempting to use a accessor to pull an icon (something like "CHARACTER_GRINNING_FACE") from the database and provide the icon.

My desire is to handle this through the eloquent model.

When I tested getting an emoji (not dynamically) the icon is provided as expected.

dd(\Spatie\Emoji\Emoji::CHARACTER_GRINNING_FACE);

However when I attempt to add an accessor to my model I get an UnknownCharacter exception.

I have attempted to use the getCharacter() method on the emoji class, with no success.

The value passed into the accessor in this example is CHARACTER_GRINNING_FACE

public function getIconAttribute($value)
{
    return Emoji::getCharacter($value);
}

I have also attempted to call the Emoji class as shown below, with no success.

public function getIconAttribute($value)
{
    return call_user_func('\Spatie\Emoji\Emoji::'.$value);
}

---

The error I get each time is the following.

Spatie\Emoji\Exceptions\UnknownCharacter
Character CHARACTER_GRINNING_FACE does not exist

---

Any advice you might have for getting the emoji character dynamically based on data in a database would be greatly appreciated.