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 inherited from Component

Primer::Component::INVALID_ARIA_LABEL_TAGS

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(value: nil, **system_arguments) ⇒ ClipboardCopy

Returns a new instance of ClipboardCopy.

Examples:

Default

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

With text instead of icons

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

Copying from an element

<%= render(Primer::ClipboardCopy.new(for: "blob-path", "aria-label": "Copy text to the system clipboard")) %>
<div id="blob-path">src/index.js</div>

Parameters:

  • aria-label (String) —

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

  • value (String) (defaults to: nil) —

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

  • for (String) —

    Element id from where to get the copied value.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



27
28
29
30
31
32
33
34
35
 
# File 'app/components/primer/clipboard_copy.rb', line 27

def initialize(value: nil, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @value = value

  validate!

  @system_arguments[:tag] = "clipboard-copy"
  @system_arguments[:value] = value if value.present?
end