lib/prawn/icon/interface.rb in prawn-icon-1.4.0 vs lib/prawn/icon/interface.rb in prawn-icon-2.0.0
- old
+ new
@@ -7,12 +7,11 @@
# This is free software. Please see the LICENSE and COPYING files for details.
module Prawn
# Easy icon font usage within Prawn. Currently
# supported icon fonts include: FontAwesome,
- # Zurb Foundicons, GitHub Octicons, as well as
- # PaymentFont.
+ # Zurb Foundicons and PaymentFont.
#
# = Icon Keys
#
# Icon keys must be supplied to most +Prawn::Icon+
# methods. Keys map directly to a unicode character
@@ -56,12 +55,12 @@
# opts::
# A hash of options that may be supplied to
# the underlying +text+ method call.
#
# == Examples:
- # pdf.icon 'fa-beer'
- # pdf.icon '<icon color="0099FF">fa-arrows</icon>',
+ # pdf.icon 'fas-beer'
+ # pdf.icon '<icon color="0099FF">fas-user-circle</icon>',
# inline_format: true
#
def icon(key, opts = {})
make_icon(key, opts).tap(&:render)
end
@@ -133,20 +132,20 @@
# == Returns:
# A Hash containing +font+ and +content+ keys
# that match the data necessary for the
# specified icon.
#
- # eg. { font: 'fa', content: '\uf047' }
+ # eg. { font: 'fas', content: "\uf2b9" }
#
# Note that the +font+ key will not be set
# if +inline_format: true+.
#
# == Examples:
# require 'prawn/table'
#
# data = [
# # Explicit brackets must be used here
- # [pdf.table_icon('fa-arrows'), 'Cell 1'],
+ # [pdf.table_icon('fas-coffee'), 'Cell 1'],
# ['Cell 2', 'Cell 3']
# ]
#
# pdf.table(data) => (2 x 2 table)
#