# frozen_string_literal: true module ButtonHelper # Output a "Copy to Clipboard" button # # data - Data attributes passed to `content_tag` (default: {}): # :text - Text to copy (optional) # :gfm - GitLab Flavored Markdown to copy, if different from `text` (optional) # :target - Selector for target element to copy from (optional) # :class - CSS classes to be applied to the button (optional) # :title - Button's title attribute (used for the tooltip) (optional) # :button_text - Button's displayed label (optional) # :hide_tooltip - Whether the tooltip should be hidden (optional, default: false) # :hide_button_icon - Whether the icon should be hidden (optional, default: false) # :item_prop - itemprop attribute # :variant - Button variant (optional, default: :default) # :category - Button category (optional, default: :tertiary) # :size - Button size (optional, default: :small) # # Examples: # # # Define the clipboard's text # clipboard_button(text: "Foo") # # => "" # # # Define the target element # clipboard_button(target: "div#foo") # # => "" # # See http://clipboardjs.com/#usage def clipboard_button(data = {}) css_class = data.delete(:class) title = data.delete(:title) || _('Copy') button_text = data[:button_text] || nil hide_tooltip = data[:hide_tooltip] || false hide_button_icon = data[:hide_button_icon] || false item_prop = data[:itemprop] || nil variant = data[:variant] || :default category = data[:category] || :tertiary size = data[:size] || :small # This supports code in app/assets/javascripts/copy_to_clipboard.js that # works around ClipboardJS limitations to allow the context-specific copy/pasting of plain text or GFM. if text = data.delete(:text) data[:clipboard_text] = if gfm = data.delete(:gfm) { text: text, gfm: gfm } else text end end target = data.delete(:target) data[:clipboard_target] = target if target unless hide_tooltip data = { toggle: 'tooltip', placement: 'bottom', container: 'body' }.merge(data) end render ::Pajamas::ButtonComponent.new( icon: hide_button_icon ? nil : 'copy-to-clipboard', variant: variant, category: category, size: size, button_options: { class: css_class, title: title, aria: { label: title, live: 'polite' }, data: data, itemprop: item_prop }) do button_text end end # Output a "Copy to Clipboard" button # Note: This is being replaced by a Pajamas-compliant helper that renders the button # via ::Pajamas::ButtonComponent. Please use clipboard_button instead. # # data - Data attributes passed to `content_tag` (default: {}): # :text - Text to copy (optional) # :gfm - GitLab Flavored Markdown to copy, if different from `text` (optional) # :target - Selector for target element to copy from (optional) # # Examples: # # # Define the clipboard's text # clipboard_button(text: "Foo") # # => "" # # # Define the target element # clipboard_button(target: "div#foo") # # => "" # # See http://clipboardjs.com/#usage def deprecated_clipboard_button(data = {}) css_class = data.delete(:class) || 'btn-clipboard gl-button btn-default-tertiary btn-icon btn-sm' title = data.delete(:title) || _('Copy') button_text = data[:button_text] || nil hide_tooltip = data[:hide_tooltip] || false hide_button_icon = data[:hide_button_icon] || false item_prop = data[:itemprop] || nil # This supports code in app/assets/javascripts/copy_to_clipboard.js that # works around ClipboardJS limitations to allow the context-specific copy/pasting of plain text or GFM. if text = data.delete(:text) data[:clipboard_text] = if gfm = data.delete(:gfm) { text: text, gfm: gfm } else text end end target = data.delete(:target) data[:clipboard_target] = target if target unless hide_tooltip data = { toggle: 'tooltip', placement: 'bottom', container: 'body' }.merge(data) end button_attributes = { class: "btn #{css_class}", data: data, type: :button, title: title, aria: { label: title, live: 'polite' }, itemprop: item_prop } content_tag :button, button_attributes do concat(sprite_icon('copy-to-clipboard', css_class: ['gl-icon', *('gl-button-icon' unless button_text.nil?)].join(' '))) unless hide_button_icon concat(content_tag(:span, button_text, class: 'gl-button-text')) unless button_text.nil? end end def http_clone_button(container, append_link: true) protocol = gitlab_config.protocol.upcase dropdown_description = http_dropdown_description(protocol) append_url = container.http_url_to_repo if append_link dropdown_item_with_description(protocol, dropdown_description, href: append_url, data: { clone_type: 'http' }) end def http_dropdown_description(protocol) if current_user.try(:require_password_creation_for_git?) _("Set a password on your account to pull or push via %{protocol}.") % { protocol: protocol } elsif current_user.try(:require_personal_access_token_creation_for_git_auth?) _("Create a personal access token on your account to pull or push via %{protocol}.") % { protocol: protocol } end end def ssh_clone_button(container, append_link: true) if Gitlab::CurrentSettings.user_show_add_ssh_key_message? && current_user.try(:require_ssh_key?) dropdown_description = s_("MissingSSHKeyWarningLink|You won't be able to pull or push repositories via SSH until you add an SSH key to your profile") end append_url = container.ssh_url_to_repo if append_link dropdown_item_with_description('SSH', dropdown_description, href: append_url, data: { clone_type: 'ssh' }) end def dropdown_item_with_description(title, description, href: nil, data: nil, default: false) active_class = "is-active" if default button_content = content_tag(:strong, title, class: 'dropdown-menu-inner-title') button_content << content_tag(:span, description, class: 'dropdown-menu-inner-content') if description content_tag (href ? :a : :span), (href ? button_content : title), class: "#{title.downcase}-selector #{active_class}", href: href, data: data end # Creates a link that looks like a button. # # It renders a Pajamas::ButtonComponent. # # It has the same API as `link_to`, but with some additional options # specific to button rendering. # # Examples: # # Default button # link_button_to _('Foo'), some_path # # # Default button using a block # link_button_to some_path do # _('Foo') # end # # # Confirm variant # link_button_to _('Foo'), some_path, variant: :confirm # # # With icon # link_button_to _('Foo'), some_path, icon: 'pencil' # # # Icon-only # # NOTE: The content must be `nil` in order to correctly render. Use aria-label # # to ensure the link is accessible. # link_button_to nil, some_path, icon: 'pencil', 'aria-label': _('Foo') # # # Small button # link_button_to _('Foo'), some_path, size: :small # # # Secondary category danger button # link_button_to _('Foo'), some_path, variant: :danger, category: :secondary # # For accessibility, ensure that icon-only links have aria-label set. def link_button_to(name = nil, href = nil, options = nil, &block) if block options = href href = name end options ||= {} # Ignore args that don't make sense for links, like disabled, loading, etc. options_for_button = %i[ category variant size block selected icon target method ] args = options.slice(*options_for_button) button_options = options.except(*options_for_button) render Pajamas::ButtonComponent.new(href: href, **args, button_options: button_options) do block.present? ? yield : name end end end ButtonHelper.prepend_mod_with('ButtonHelper')