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
Instance Method Summary collapse
- #audit_icon(name, css_class: nil) ⇒ Object
- #boolean_to_icon(value) ⇒ Object
- #custom_icon(icon_name, size: DEFAULT_ICON_SIZE) ⇒ Object
- #external_snippet_icon(name) ⇒ Object
- #file_type_icon_class(type, mode, name) ⇒ Object
-
#gl_loading_icon(inline: false, color: 'dark', size: 'sm', css_class: nil) ⇒ Object
Creates a GitLab UI loading icon/spinner.
- #sprite_file_icons_path ⇒ Object
- #sprite_icon(icon_name, size: DEFAULT_ICON_SIZE, css_class: nil) ⇒ Object
- #sprite_icon_path ⇒ Object
- #visibility_level_icon(level, options: {}) ⇒ Object
Instance Method Details
#audit_icon(name, css_class: nil) ⇒ Object
91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'app/helpers/icons_helper.rb', line 91 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
104 105 106 107 108 109 110 |
# File 'app/helpers/icons_helper.rb', line 104 def boolean_to_icon(value) if value sprite_icon('check', css_class: 'gl-text-green-500') else sprite_icon('power', css_class: 'gl-text-gray-500') end end |
#custom_icon(icon_name, size: DEFAULT_ICON_SIZE) ⇒ Object
10 11 12 13 14 |
# File 'app/helpers/icons_helper.rb', line 10 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
87 88 89 |
# File 'app/helpers/icons_helper.rb', line 87 def external_snippet_icon(name) content_tag(:span, "", class: "gl-snippet-icon gl-snippet-icon-#{name}") end |
#file_type_icon_class(type, mode, name) ⇒ Object
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'app/helpers/icons_helper.rb', line 128 def file_type_icon_class(type, mode, name) if type == 'folder' icon_class = 'folder-o' elsif type == 'archive' icon_class = 'archive' 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 = 'document' when '.jpg', '.jpeg', '.jif', '.jfif', '.jp2', '.jpx', '.j2k', '.j2c', '.apng', '.png', '.gif', '.tif', '.tiff', '.svg', '.ico', '.bmp', '.webp' icon_class = 'doc-image' when '.zip', '.zipx', '.tar', '.gz', '.gzip', '.tgz', '.bz', '.bzip', '.bz2', '.bzip2', '.car', '.tbz', '.xz', 'txz', '.rar', '.7z', '.lz', '.lzma', '.tlz' icon_class = 'doc-compressed' when '.mp3', '.wma', '.ogg', '.oga', '.wav', '.flac', '.aac', '.3ga', '.ac3', '.midi', '.m4a', '.ape', '.mpa' icon_class = 'volume-up' when '.mp4', '.m4p', '.m4v', '.mpg', '.mp2', '.mpeg', '.mpe', '.mpv', '.mpg', '.mpeg', '.m2v', '.m2ts', '.avi', '.mkv', '.flv', '.ogv', '.mov', '.3gp', '.3g2' icon_class = 'live-preview' when '.doc', '.dot', '.docx', '.docm', '.dotx', '.dotm', '.docb', '.odt', '.ott', '.uot', '.rtf' icon_class = 'doc-text' when '.xls', '.xlt', '.xlm', '.xlsx', '.xlsm', '.xltx', '.xltm', '.xlsb', '.xla', '.xlam', '.xll', '.xlw', '.ots', '.ods', '.uos' icon_class = 'document' when '.ppt', '.pot', '.pps', '.pptx', '.pptm', '.potx', '.potm', '.ppam', '.ppsx', '.ppsm', '.sldx', '.sldm', '.odp', '.otp', '.uop' icon_class = 'doc-chart' else icon_class = 'doc-text' end end icon_class end |
#gl_loading_icon(inline: false, color: 'dark', size: 'sm', css_class: 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
73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'app/helpers/icons_helper.rb', line 73 def gl_loading_icon(inline: false, color: 'dark', size: 'sm', css_class: nil) spinner = content_tag(:span, "", { class: %[gl-spinner gl-spinner-#{color} gl-spinner-#{size} gl-vertical-align-text-bottom!], aria: { label: _('Loading') } }) container_classes = ['gl-spinner-container'] container_classes << css_class unless css_class.blank? content_tag(inline ? :span : :div, spinner, { class: container_classes, role: 'status' }) end |
#sprite_file_icons_path ⇒ Object
25 26 27 28 29 30 |
# File 'app/helpers/icons_helper.rb', line 25 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.svg', host: sprite_base_url) end |
#sprite_icon(icon_name, size: DEFAULT_ICON_SIZE, css_class: nil) ⇒ Object
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'app/helpers/icons_helper.rb', line 32 def sprite_icon(icon_name, size: DEFAULT_ICON_SIZE, css_class: nil) memoized_icon("#{icon_name}_#{size}_#{css_class}") do if known_sprites&.exclude?(icon_name) 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 << "#{css_class}" unless css_class.blank? content_tag( :svg, content_tag(:use, '', { 'href' => "#{sprite_icon_path}##{icon_name}" } ), class: css_classes.empty? ? nil : css_classes.join(' '), data: { testid: "#{icon_name}-icon" } ) end end |
#sprite_icon_path ⇒ Object
16 17 18 19 20 21 22 23 |
# File 'app/helpers/icons_helper.rb', line 16 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
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'app/helpers/icons_helper.rb', line 112 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 = .delete(:class) sprite_icon(name, size: DEFAULT_ICON_SIZE, css_class: css_class) end |