christofferok/laravel-emojione

Laravel helper for EmojiOne

laravel-emojione

![Total Downloads][ico-downloads] ![Software License][ico-license], _(*1)

, _(*2)

Laravel package to make it easier working with the gorgeous emojis from EmojiOne., _(*3)

Remember to read the EmojiOne Free License and provide the appropriate attribution. Or buy a premium license, _(*4)

Upgrading from 3.x to 4.x

1. Update your composer dependency to: "christofferok/laravel-emojione": "^4.0" and run composer update
2. Update config/emojione.php (if you have one) with 'emojiVersion' => '4.0'

If you are serving the assets yourself then you need to do the following things:, _(*5)

1. Update your emojione/assets composer dependency to: "emojione/assets": "^4.0" and run composer update
2. Update config/emojione.php with the correct paths and versions
3. Publish the assets again. See "Assets" section further down

EmojiOne 4.x/3.x vs 2.0

EmojiOne made a lot of changes in their licensing and which resources are provided in the free license. v2 code is still available in the emojione-v2 branch. If you are upgrading this package, be aware that the SVG assets are not available anymore., _(*6)

Install

Via Composer, _(*7)

``` bash $ composer require christofferok/laravel-emojione, <sub>(*8)</sub>

__If you are on Laravel 5.4 or lower you need to add the following to your `config/app.php` file:__

Add the ServiceProvider to the providers array in `config/app.php`

``` php
ChristofferOK\LaravelEmojiOne\LaravelEmojiOneServiceProvider::class,

Add this to the aliases array in config/app.php, <sub>(*9)</sub>

``` php 'LaravelEmojiOne' => ChristofferOK\LaravelEmojiOne\LaravelEmojiOneFacade::class,, <sub>(*10)</sub>

Config:

``` bash
$ php artisan vendor:publish --tag=config --provider="ChristofferOK\LaravelEmojiOne\LaravelEmojiOneServiceProvider"

Usage

``` php LaravelEmojiOne::toShort($str); // - native unicode -> shortnames LaravelEmojiOne::shortnameToImage($str); // - shortname -> images LaravelEmojiOne::unicodeToImage($str); // - native unicode -> images LaravelEmojiOne::toImage($str); // - native unicode + shortnames -> images (mixed input), <sub>(*11)</sub>

Blade (equivalent to `LaravelEmojiOne::toImage($str)`): 

`@emojione(':smile:')` -> <img alt="😀" width="20" src="https://cdn.jsdelivr.net/emojione/assets/4.0/png/64/1f600.png">

`@emojione(':smile: ❤️')` -> <img alt="😀" width="20" src="https://cdn.jsdelivr.net/emojione/assets/4.0/png/128/1f600.png"><img alt="❤️" width="20" src="https://cdn.jsdelivr.net/emojione/assets/4.0/png/128/2764.png">

🚨 The output is not escaped so be careful with what you pass into `@emojione`.

More details about how `toImage($str)` works can be found at [https://github.com/Ranks/emojione/blob/master/examples/PHP.md](https://github.com/Ranks/emojione/blob/master/examples/PHP.md)

### Example
You want to let users put emoji a comment. 
When you are saving a comment, you might want to run the content through `LaravelEmojiOne::toShort($str)` to convert `😄` and other emoji to `:smile:` etc. 

```php
Comment::create([
  'content' => LaravelEmojiOne::toShort(request('content'))
]);

So if someone leaves a comment like This is an awesome comment 😄🔥 it will be saved as This is an awesome comment :smile: :fire:, <sub>(*12)</sub>

In your view where you display your comments you can use, <sub>(*13)</sub>

@emojione($comment->content)

and that will convert :smile: and 😄 to the emojione equivalent., <sub>(*14)</sub>

Assets

By default it will use the assets from JSDelivr., <sub>(*15)</sub>

Remember to run this before trying to publish any of the assets:, <sub>(*16)</sub>

composer require emojione/assets

If you want to serve the assets yourself you can publish them with the following commands. Remember to update config/emojione.php, <sub>(*17)</sub>

PNG files in sizes 32/64/128:, <sub>(*18)</sub>

``` bash $ php artisan vendor:publish --tag=public --provider="ChristofferOK\LaravelEmojiOne\LaravelEmojiOneServiceProvider", <sub>(*19)</sub>

In `config/emojione.php` specify the local path. Remember to specify which size you want in the path (32/64/128). 

```php
'imagePathPNG' => '/vendor/emojione/png/64/',

Sprites

If you want to use sprites:, <sub>(*20)</sub>

``` bash $ php artisan vendor:publish --tag=sprites --provider="ChristofferOK\LaravelEmojiOne\LaravelEmojiOneServiceProvider", <sub>(*21)</sub>

In `config/emojione.php` enable sprites:

```php
'sprites' => true,
'spriteSize' => 32, // 32 or 64

Add the stylesheet to your HTML:, <sub>(*22)</sub>

<link rel="stylesheet" href="/vendor/emojione/sprites/emojione-sprite-{{ config('emojione.spriteSize') }}.min.css"/>

License

Remember to read the EmojiOne Free License and provide the appropriate attribution. Or buy a premium license, <sub>(*23)</sub>