Class: Primer::ClipboardCopy

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/clipboard_copy.rb

Overview

Use ‘ClipboardCopy` to copy element text content or input values to the clipboard.

Constant Summary

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(label:, value:, **system_arguments) ⇒ ClipboardCopy

Returns a new instance of ClipboardCopy.

Examples:

Default

<%= render(Primer::ClipboardCopy.new(value: "Text to copy", label: "Copy text to the system clipboard")) %>

With text instead of icons

<%= render(Primer::ClipboardCopy.new(value: "Text to copy", label: "Copy text to the system clipboard")) do %>
  Click to copy!
<% end %>

Parameters:

  • label (String) —

    String that will be read to screenreaders when the component is focused

  • value (String) —

    Text to copy into the users clipboard when they click the component

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



19
20
21
22
23
24
 
# File 'app/components/primer/clipboard_copy.rb', line 19

def initialize(label:, value:, **system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] = "clipboard-copy"
  @system_arguments[:value] = value
  @system_arguments[:"aria-label"] = label
end