summaryrefslogtreecommitdiff
path: root/app/helpers/lazy_image_tag_helper.rb
blob: 10d603ef5d3ba390d9bfdb01d7c79a07bf7d94b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# frozen_string_literal: true

module LazyImageTagHelper
  include PreferencesHelper

  def placeholder_image
    "data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="
  end

  # Override the default ActionView `image_tag` helper to support lazy-loading
  # accept :auto_dark boolean to enable automatic dark variant of the image
  # (see: https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/2698)
  # accept :dark_variant path to be used as a source when dark mode is enabled
  def image_tag(source, options = {})
    source, options = prepare_dark_variant(source, options)
    options = options.symbolize_keys

    unless options.delete(:lazy) == false
      options[:data] ||= {}
      options[:data][:src] = path_to_image(source)

      # options[:class] can be either String or Array.
      klass_opts = Array.wrap(options[:class])
      klass_opts << "lazy"

      options[:class] = klass_opts.join(' ')
      source = placeholder_image
    end

    super(source, options)
  end

  # Required for Banzai::Filter::ImageLazyLoadFilter
  module_function :placeholder_image # rubocop: disable Style/AccessModifierDeclarations

  private

  def prepare_dark_variant(source, options)
    dark_variant = options.delete(:dark_variant)
    auto_dark = options.delete(:auto_dark)

    if dark_variant && auto_dark
      raise ArgumentError, "dark_variant and auto_dark are mutually exclusive"
    end

    if (auto_dark || dark_variant) && user_application_dark_mode?
      if auto_dark
        options[:class] = 'gl-dark-invert-keep-hue'
      elsif dark_variant
        source = dark_variant
      end
    end

    [source, options]
  end
end