Test Gem Version Maintainability

Prawn::Emoji is an extention that adds Emoji support to Prawn.

require 'prawn/emoji'

Prawn::Document.generate 'sushi.pdf' do
  font 'DejaVuSans.ttf'
  text '🐟 / 🔪 + 🍚 / 🍾 = 🍣'

For execute this code, you need DejaVuSans.ttf font.



  • Emoji is provided by Twemoji
  • Support Singleton/Combining/Modifier/Flag/ZWJ Sequence Emoji

See test/pdf/emoji_rendering/expect.pdf for details.

Prawn Integration

  • RTL support
  • Character spacing support
  • Rotation support
  • Alignment support
  • Font size support

See test/pdf/prawn_integration/expect.pdf for details.

Known Issues


Supported Versions




2.2, 2.3, 2.4


2.5, 2.6, 2.7, 3.0


Add this line to your application's Gemfile:

gem 'prawn-emoji', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install prawn-emoji


require 'prawn/emoji'

True Type Font Required

In order to draw Emoji, you must use a True Type Font.

Configuring Emoji Regex

Emoji Regex is a regular expression used to determine which emoji to draw.

Prawn::Emoji.config.regex # => ::Unicode::Emoji::REGEX_VALID by default

You can override it with unicode-emoji's Regex:

Prawn::Emoji.config.regex = ::Unicode::Emoji::REGEX_INCLUDE_TEXT


Bug reports and pull requests are welcome on GitHub at


Running tests

Run all tests:

$ bundle exec rake test

Run unit tests:

$ bundle exec rake test:units

Run pdf tests:

$ bundle exec rake test:pdf

In order to run test:pdf, you need to install diff-pdf in your environment, or you can run test in the docker container as below.

Running tests in the docker container for development

You can use the docker container for development. This container contains the libraries required for testing, such as diff-pdf.

$ docker build -t prawn-emoji:latest .
$ docker run -v $PWD:/src:cached -it prawn-emoji bash

> src#

You can run test:

> src# bundle install
> src# bundle exec rake test

Or, you can run test instantly like this:

$ docker run --rm -v $PWD:/src:cached -it prawn-emoji bash -c "bundle install && bundle exec rake test:pdf"

Updating the bundled emojis

$ bundle exec rake emoji:update VERSION=<Twemoji version>

This task works the following:

  1. Download emoji images from
  2. Save the emoji images in the emoji/images/
  3. Write image list in emoji/images/ to emoji/index.yml
  4. Update version in emoji/LICENSE


© 2015 Katsuya HIDAKA. See MIT-LICENSE for further details.


Twemoji Graphics licensed under CC-BY4.0. See emoji/LICENSE for futher details.

IPA Font

IPA Font License Agreement v1.0