Module: IconsHelper

Includes:
FontAwesome::Rails::IconHelper
Included in:
NotificationsHelper
Defined in:
app/helpers/icons_helper.rb

Instance Method Summary collapse

Instance Method Details

#audit_icon(names, options = {}) ⇒ Object


13
14
15
16
17
18
19
20
# File 'app/helpers/icons_helper.rb', line 13

def audit_icon(names, options = {})
  case names
  when "standard"
    names = "key"
  end

  options.include?(:base) ? fa_stacked_icon(names, options) : fa_icon(names, options)
end

#boolean_to_icon(value) ⇒ Object


31
32
33
34
35
36
37
# File 'app/helpers/icons_helper.rb', line 31

def boolean_to_icon(value)
  if value
    icon('circle', class: 'cgreen')
  else
    icon('power-off', class: 'clgray')
  end
end

#file_type_icon_class(type, mode, name) ⇒ Object


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'app/helpers/icons_helper.rb', line 55

def file_type_icon_class(type, mode, name)
  if type == 'folder'
    icon_class = 'folder'
  elsif mode == '120000'
    icon_class = 'share'
  else
    # Guess which icon to choose based on file extension.
    # If you think a file extension is missing, feel free to add it on PR

    case File.extname(name).downcase
    when '.pdf'
      icon_class = 'file-pdf-o'
    when '.jpg', '.jpeg', '.jif', '.jfif',
        '.jp2', '.jpx', '.j2k', '.j2c',
        '.png', '.gif', '.tif', '.tiff',
        '.svg', '.ico', '.bmp'
      icon_class = 'file-image-o'
    when '.zip', '.zipx', '.tar', '.gz', '.bz', '.bzip',
        '.xz', '.rar', '.7z'
      icon_class = 'file-archive-o'
    when '.mp3', '.wma', '.ogg', '.oga', '.wav', '.flac', '.aac'
      icon_class = 'file-audio-o'
    when '.mp4', '.m4p', '.m4v',
        '.mpg', '.mp2', '.mpeg', '.mpe', '.mpv',
        '.mpg', '.mpeg', '.m2v',
        '.avi', '.mkv', '.flv', '.ogv', '.mov',
        '.3gp', '.3g2'
      icon_class = 'file-video-o'
    when '.doc', '.dot', '.docx', '.docm', '.dotx', '.dotm', '.docb'
      icon_class = 'file-word-o'
    when '.xls', '.xlt', '.xlm', '.xlsx', '.xlsm', '.xltx', '.xltm',
        '.xlsb', '.xla', '.xlam', '.xll', '.xlw'
      icon_class = 'file-excel-o'
    when '.ppt', '.pot', '.pps', '.pptx', '.pptm', '.potx', '.potm',
        '.ppam', '.ppsx', '.ppsm', '.sldx', '.sldm'
      icon_class = 'file-powerpoint-o'
    else
      icon_class = 'file-text-o'
    end
  end

  icon_class
end

#icon(names, options = {}) ⇒ Object

Creates an icon tag given icon name(s) and possible icon modifiers.

Right now this method simply delegates directly to `fa_icon` from the font-awesome-rails gem, but should we ever use a different icon pack in the future we won't have to change hundreds of method calls.


9
10
11
# File 'app/helpers/icons_helper.rb', line 9

def icon(names, options = {})
  options.include?(:base) ? fa_stacked_icon(names, options) : fa_icon(names, options)
end

#spinner(text = nil, visible = false) ⇒ Object


22
23
24
25
26
27
28
29
# File 'app/helpers/icons_helper.rb', line 22

def spinner(text = nil, visible = false)
  css_class = 'loading'
  css_class << ' hide' unless visible

   :div, class: css_class do
    icon('spinner spin') + text
  end
end

#visibility_level_icon(level, fw: true) ⇒ Object


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'app/helpers/icons_helper.rb', line 39

def visibility_level_icon(level, fw: true)
  name =
    case level
    when Gitlab::VisibilityLevel::PRIVATE
      'lock'
    when Gitlab::VisibilityLevel::INTERNAL
      'shield'
    else # Gitlab::VisibilityLevel::PUBLIC
      'globe'
    end

  name << " fw" if fw

  icon(name)
end