jonnybarnes/emoji-a11y

Make emoji more accessible

v0.3 2017-07-04 16:12 UTC

Requires

• php: >=7.0

Requires (Dev)

• phpunit/phpunit: ~6.0

CC0-1.0

• Jonny Barnes

• emoji
• accessibility
• a11y

README

Make emoji more accessible.

Install

Add this package with composer:

composer require jonnybarnes/emoji-a11y

Usage

Anywhere you have some text with emoji use the makeEmojiAccessible method.

$emoji = new Jonnybarnes\EmojiA11y\EmojiModifier();
$text = 'I’m 😀';
$emoji->makeEmojiAccessible($text); // I’m <span role="img" aria-label="grinning face">😀</span>

Customise HTML

You can pass in a string to the constructor that will be used in the makeEmojiAccessible method. We use PHP’s sprinf function.

Three variables are passed into the function. The desired output form, then the text of the emoji, then the matched emoji character. Thankfully sprintf allows you to swap variable order if you need to, see example 3 in the manual.

Of course you need to provide your own CSS for presentation.

Inspired by http://adrianroselli.com/2016/12/accessible-emoji-tweaked.html