Module: FontAwesome::Rails::IconHelper

Defined in:
app/helpers/font_awesome/rails/icon_helper.rb

Defined Under Namespace

Modules: Private

Instance Method Summary collapse

Instance Method Details

#fa_icon(names = "flag", original_options = {}) ⇒ Object

Creates an icon tag given an icon name and possible icon modifiers.

Examples

fa_icon "camera-retro"
# => <i class="fa fa-camera-retro"></i>

fa_icon "camera-retro", text: "Take a photo"
# => <i class="fa fa-camera-retro"></i> Take a photo
fa_icon "chevron-right", text: "Get started", right: true
# => Get started <i class="fa fa-chevron-right"></i>

fa_icon "camera-retro 2x"
# => <i class="fa fa-camera-retro fa-2x"></i>
fa_icon ["camera-retro", "4x"]
# => <i class="fa fa-camera-retro fa-4x"></i>
fa_icon "spinner spin lg"
# => <i class="fa fa-spinner fa-spin fa-lg">

fa_icon "quote-left 4x", class: "pull-left"
# => <i class="fa fa-quote-left fa-4x pull-left"></i>

fa_icon "user", data: { id: 123 }
# => <i class="fa fa-user" data-id="123"></i>

content_tag(:li, fa_icon("check li", text: "Bulleted list item"))
# => <li><i class="fa fa-check fa-li"></i> Bulleted list item</li>



32
33
34
35
36
37
38
39
40
41
 
# File 'app/helpers/font_awesome/rails/icon_helper.rb', line 32

def fa_icon(names = "flag", original_options = {})
  options = original_options.deep_dup
  classes = ["fa"]
  classes.concat Private.icon_names(names)
  classes.concat Array(options.delete(:class))
  text = options.delete(:text)
  right_icon = options.delete(:right)
  icon = content_tag(:i, nil, options.merge(:class => classes))
  Private.icon_join(icon, text, right_icon)
end

#fa_stacked_icon(names = "flag", original_options = {}) ⇒ Object

Creates an stack set of icon tags given a base icon name, a main icon name, and possible icon modifiers.

Examples

fa_stacked_icon "twitter", base: "square-o"
# => <span class="fa-stack">
# =>   <i class="fa fa-square-o fa-stack-2x"></i>
# =>   <i class="fa fa-twitter fa-stack-1x"></i>
# => </span>

fa_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
# => <span class="fa-stack pull-right">
# =>   <i class="fa fa-square fa-stack-2x"></i>
# =>   <i class="fa fa-terminal fa-inverse fa-stack-1x"></i>
# => </span> Hi!

fa_stacked_icon "camera", base: "ban-circle", reverse: true
# => <span class="fa-stack">
# =>   <i class="fa fa-camera fa-stack-1x"></i>
# =>   <i class="fa fa-ban-circle fa-stack-2x"></i>
# => </span>



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'app/helpers/font_awesome/rails/icon_helper.rb', line 65

def fa_stacked_icon(names = "flag", original_options = {})
  options = original_options.deep_dup
  classes = Private.icon_names("stack").concat(Array(options.delete(:class)))
  base_names = Private.array_value(options.delete(:base) || "square-o").push("stack-2x")
  names = Private.array_value(names).push("stack-1x")
  base = fa_icon(base_names, options.delete(:base_options) || {})
  icon = fa_icon(names, options.delete(:icon_options) || {})
  icons = [base, icon]
  icons.reverse! if options.delete(:reverse)
  text = options.delete(:text)
  right_icon = options.delete(:right)
  stacked_icon = content_tag(:span, safe_join(icons), options.merge(:class => classes))
  Private.icon_join(stacked_icon, text, right_icon)
end