Module: IconsHelper

Extended by:
IconsHelper
Included in:
Ci::RunnersHelper, DashboardHelper, DiffFileEntity, Gitlab::BlamePresenter, Gitlab::Conflict::File, IconsHelper, NotificationsHelper, ProjectPresenter
Defined in:
app/helpers/icons_helper.rb

Constant Summary collapse

DEFAULT_ICON_SIZE = 
16
VARIANT_CLASSES = 
{
  current: 'gl-fill-current',
  default: 'gl-fill-icon-default',
  subtle: 'gl-fill-icon-subtle',
  strong: 'gl-fill-icon-strong',
  disabled: 'gl-fill-icon-disabled',
  link: 'gl-fill-icon-link',
  info: 'gl-fill-icon-info',
  warning: 'gl-fill-icon-warning',
  danger: 'gl-fill-icon-danger',
  success: 'gl-fill-icon-success'
}.freeze

Instance Method Summary collapse

Instance Method Details

#audit_icon(name, css_class: nil) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'app/helpers/icons_helper.rb', line 129

def audit_icon(name, css_class: nil)
  case name
  when "standard"
    name = "key"
  when "two-factor"
    name = "key"
  when "google_oauth2"
    name = "google"
  end

  sprite_icon(name, css_class: css_class)
end

#boolean_to_icon(value) ⇒ Object 



142
143
144
145
146
147
148
149
 
# File 'app/helpers/icons_helper.rb', line 142

def boolean_to_icon(value)
  if value
    sprite_icon('check',
      css_class: 'gl-text-success') + content_tag(:span, _('Enabled'), class: 'gl-pl-2 gl-text-subtle')
  else
    content_tag(:span, _('Not enabled'), class: 'gl-text-subtle')
  end
end

#custom_icon(icon_name, size: DEFAULT_ICON_SIZE) ⇒ Object 



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

def custom_icon(icon_name, size: DEFAULT_ICON_SIZE)
  memoized_icon("#{icon_name}_#{size}") do
    render partial: "shared/icons/#{icon_name}", formats: :svg, locals: { size: size }
  end
end

#external_snippet_icon(name) ⇒ Object 



125
126
127
 
# File 'app/helpers/icons_helper.rb', line 125

def external_snippet_icon(name)
  content_tag(:span, "", class: "gl-snippet-icon gl-snippet-icon-#{name}") # rubocop:disable Tailwind/StringInterpolation -- Not a CSS utility class
end

#file_type_icon_class(type, mode, name) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'app/helpers/icons_helper.rb', line 168

def file_type_icon_class(type, mode, name)
  if type == 'folder'
    'folder'
  elsif type == 'archive'
    'archive'
  elsif mode == '120000'
    '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'
      'document'
    when '.jpg', '.jpeg', '.jif', '.jfif',
         '.jp2', '.jpx', '.j2k', '.j2c',
         '.apng', '.png', '.gif', '.tif', '.tiff',
         '.svg', '.ico', '.bmp', '.webp'
      'doc-image'
    when '.zip', '.zipx', '.tar', '.gz', '.gzip', '.tgz', '.bz', '.bzip',
         '.bz2', '.bzip2', '.car', '.tbz', '.xz', 'txz', '.rar', '.7z',
         '.lz', '.lzma', '.tlz'
      'doc-compressed'
    when '.mp3', '.wma', '.ogg', '.oga', '.wav', '.flac', '.aac', '.3ga',
         '.ac3', '.midi', '.m4a', '.ape', '.mpa'
      'volume-up'
    when '.mp4', '.m4p', '.m4v',
         '.mpg', '.mp2', '.mpeg', '.mpe', '.mpv',
         '.m2v', '.m2ts',
         '.avi', '.mkv', '.flv', '.ogv', '.mov',
         '.3gp', '.3g2'
      'live-preview'
    when '.doc', '.dot', '.docx', '.docm', '.dotx', '.dotm', '.docb',
         '.odt', '.ott', '.uot', '.rtf'
      'doc-text'
    when '.xls', '.xlt', '.xlm', '.xlsx', '.xlsm', '.xltx', '.xltm',
         '.xlsb', '.xla', '.xlam', '.xll', '.xlw', '.ots', '.ods', '.uos'
      'document'
    when '.ppt', '.pot', '.pps', '.pptx', '.pptm', '.potx', '.potm',
         '.ppam', '.ppsx', '.ppsm', '.sldx', '.sldm', '.odp', '.otp', '.uop'
      'doc-chart'
    else
      'doc-text'
    end
  end
end

#gl_loading_icon(inline: false, color: 'dark', size: 'sm', css_class: nil, data: nil) ⇒ Object

Creates a GitLab UI loading icon/spinner.

Examples:

# Default
gl_loading_icon

# Sizes
gl_loading_icon(size: 'md')
gl_loading_icon(size: 'lg')
gl_loading_icon(size: 'xl')

# Colors
gl_loading_icon(color: 'light')

# Block/Inline
gl_loading_icon(inline: true)

# Custom classes
gl_loading_icon(css_class: "foo-bar")

See also gitlab-org.gitlab.io/gitlab-ui/?path=/story/base-loading-icon–default



115
116
117
118
119
120
121
122
123
 
# File 'app/helpers/icons_helper.rb', line 115

def gl_loading_icon(inline: false, color: 'dark', size: 'sm', css_class: nil, data: nil)
  render Pajamas::SpinnerComponent.new(
    inline: inline,
    color: color,
    size: size,
    class: css_class,
    data: data
  )
end

#illustrations_path ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'app/helpers/icons_helper.rb', line 45

def illustrations_path
  @illustrations_path ||= begin
    # SVG Sprites currently don't work across domains, so in the case of a CDN
    # we have to set the current path deliberately to prevent addition of asset_host
    sprite_base_url = Gitlab.config.gitlab.url if ActionController::Base.asset_host
    ActionController::Base.helpers.image_path('illustrations.svg', host: sprite_base_url)
  end
end

#sprite_file_icons_path ⇒ Object 



38
39
40
41
42
43
 
# File 'app/helpers/icons_helper.rb', line 38

def sprite_file_icons_path
  # SVG Sprites currently don't work across domains, so in the case of a CDN
  # we have to set the current path deliberately to prevent addition of asset_host
  sprite_base_url = Gitlab.config.gitlab.url if ActionController::Base.asset_host
  ActionController::Base.helpers.image_path('file_icons/file_icons.svg', host: sprite_base_url)
end

#sprite_icon(icon_name, size: DEFAULT_ICON_SIZE, css_class: nil, file_icon: false, aria_label: nil, variant: nil, color: nil) ⇒ Object 



54
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
 
# File 'app/helpers/icons_helper.rb', line 54

def sprite_icon(
  icon_name,
  size: DEFAULT_ICON_SIZE,
  css_class: nil,
  file_icon: false,
  aria_label: nil,
  variant: nil,
  color: nil
)
  memoized_icon("#{icon_name}_#{size}_#{css_class}_#{variant}_#{color.presence || ''}") do
    unknown_icon = file_icon ? unknown_file_icon_sprite(icon_name) : unknown_icon_sprite(icon_name)
    if unknown_icon
      exception = ArgumentError.new("#{icon_name} is not a known icon in @gitlab-org/gitlab-svg")
      Gitlab::ErrorTracking.track_and_raise_for_dev_exception(exception)
    end

    css_classes = []
    css_classes << "s#{size}" if size
    css_classes << VARIANT_CLASSES[variant&.to_sym]
    css_classes << css_class.to_s unless css_class.blank?
    css_classes.compact!

    sprite_path = file_icon ? sprite_file_icons_path : sprite_icon_path

    svg_options = {
      class: css_classes.empty? ? nil : css_classes.join(' '),
      data: { testid: "#{icon_name}-icon" },
      'aria-label': aria_label
    }

    svg_options[:style] = "fill: #{color};" if color.present?

    content_tag(
      :svg,
      content_tag(:use, '', { 'href' => "#{sprite_path}##{icon_name}" }),
      svg_options
    )
  end
end

#sprite_icon_path ⇒ Object 



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

def sprite_icon_path
  @sprite_icon_path ||= begin
    # SVG Sprites currently don't work across domains, so in the case of a CDN
    # we have to set the current path deliberately to prevent addition of asset_host
    sprite_base_url = Gitlab.config.gitlab.url if ActionController::Base.asset_host
    ActionController::Base.helpers.image_path('icons.svg', host: sprite_base_url)
  end
end

#visibility_level_icon(level, options: {}) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'app/helpers/icons_helper.rb', line 151

def visibility_level_icon(level, options: {})
  name =
    case level
    when Gitlab::VisibilityLevel::PRIVATE
      'lock'
    when Gitlab::VisibilityLevel::INTERNAL
      'shield'
    else # Gitlab::VisibilityLevel::PUBLIC
      'earth'
    end

  css_class = options.delete(:class)
  variant = options.delete(:variant)

  sprite_icon(name, size: DEFAULT_ICON_SIZE, css_class: css_class, variant: variant)
end