overtrue / laravel-emoji

3.0.0 2026-10-04 01:04 UTC

Requires

• php: ^8.3
• joypixels/emoji-toolkit: ^6.6
• laravel/framework: ^13.0

Requires (Dev)

• laravel/pint: *
• orchestra/testbench: ^11.0
• phpunit/phpunit: ^12.5

MIT

• overtrue

Published on Packagist.org on 2026-10-04 01:06 UTC

README

😄 This package assist you in getting started with emoji easily.

Requirements

Version 3 requires PHP 8.3 or newer (PHP 8.x) and Laravel 13. Laravel 9, 10, 11, and 12 are not supported by version 3.

Installing

$ composer require overtrue/laravel-emoji

Usage

Emoji::toImage(':smile:'); // <img class="emojione" alt="&#x1f604;" title=":smile:" src="https://cdn.jsdelivr.net/emojione/assets/3.1/png/32/1f604.png"/>'
Emoji::toShort('😄'); // :smile:
Emoji::shortnameToUnicode(':smile:'); // 😄

// using helper
// default transform shortname to unicode, you can change it in config file.
emoji(':smile:'); // 😄

// access emoji services, return \JoyPixels\Client instance.
app('emoji');
// or 
app(\JoyPixels\Client::class);

Configurations

// config
$ php artisan vendor:publish --provider="Overtrue\\LaravelEmoji\\EmojiServiceProvider" --tag=laravel-emoji

Upgrading to version 3

Upgrade the application to Laravel 13 and PHP 8.3 or newer before installing version 3. The helper, facade, Blade directive, and config/emoji.php options retain their existing APIs. The helper now resolves the same JoyPixels client as the facade and container alias.

The unused Composer git-hook scripts have been removed. Contributors can run the checks directly:

composer install
composer test
composer check-style

❤️ Sponsor me

如果你喜欢我的项目并想支持它，点击这里 ❤️

Project supported by JetBrains

Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.

License

MIT