Clipboard copy

The clipboard copy component allows users to quickly and easily copy content to their clipboard.

Examples

Basic

Expandable

Editable

This is an editable version of the copy to clipboard component that has an expandable section. Got a lot of text here, need to see all of it? Click that arrow on the left side and check out the resulting expansion.

Read-only

Code

{ "menu": {
    "id": "file",
    "value": "File",
    "popup": {
      "menuitem": [
        {"value": "New", "onclick": "CreateNewDoc()"},
        {"value": "Open", "onclick": "OpenDoc()"},
        {"value": "Close", "onclick": "CloseDoc()"}
      ]
    }
  }}

{ "menu": {
    "id": "file",
    "value": "File",
    "popup": {
      "menuitem": [
        {"value": "New", "onclick": "CreateNewDoc()"},
        {"value": "Open", "onclick": "OpenDoc()"},
        {"value": "Close", "onclick": "CloseDoc()"}
      ]
    }
  }}

Inline compact

2.3.4-2-redhat

Inline compact code

2.3.4-2-redhat

Inline compact with additional action

2.3.4-2-redhat

Inline compact in sentence

Basic

Lorem ipsum

2.3.4-2-redhat

dolor sit amet.

Long copy string

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

https://app.openshift.io/path/sub-path/sub-sub-path/?runtime=quarkus/12345678901234567890/abcdefghijklmnopqrstuvwxyz1234567890

Mauris luctus, libero nec dapibus ultricies, urna purus pretium mauris, ullamcorper pharetra lacus nibh vitae enim.

Long copy string in block

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

https://app.openshift.io/path/sub-path/sub-sub-path/?runtime=quarkus/12345678901234567890/abcdefghijklmnopqrstuvwxyz1234567890

Mauris luctus, libero nec dapibus ultricies, urna purus pretium mauris, ullamcorper pharetra lacus nibh vitae enim.

Documentation

Accessibility

Attribute	Applied to	Outcome
`aria-label="Copy to clipboard"`, `aria-label="Show content"`	`.pf-v6-c-button.pf-m-control`	Provides an accessible name for the button when an icon is used instead of text. Required when an icon is used with no supporting text.
`aria-label="[input label text]"`	`.pf-v6-c-form-control`	Provides an accessible label for the input. Provide a label that describes the contents in the input. Required
`aria-hidden="true"`	`<i>`	Hides the icon from assistive technologies.
`aria-controls="[id of expandable element]"`	`.pf-v6-c-button.pf-m-control`	Identifies the element controlled by the toggle button. Required
`hidden`	`.pf-v6-c-clipboard-copy__expandable-content`	Indicates that the expandable content is hidden so that it isn't visible in the UI and isn't accessed by assistive technologies.
`aria-labelledby="[id of button] [id of input label]"`	`.pf-v6-c-button.pf-m-control`	Provides an accessible name that is unique and communicates context of the button. Required when more than one ClipboardCopy component exists on the page. Important: If the label is defined on the `<input>` using `aria-label`, then use the `id` of the `<input>`. If the label is defined in a `<label>`, then use the `id` of the `<label>`. Alternatively this attribute can be ignored if the text input label is defined as part of the value in `aria-label`.

Usage

Class	Applied to	Outcome
`.pf-v6-c-clipboard-copy`	`<div>`	Initiates a clipboard copy component. Required
`.pf-v6-c-clipboard-copy__group`	`<div>`	Initiates a wrapper for the clipboard copy group. Required
`.pf-v6-c-clipboard-copy__toggle-icon`	`<div>`	Initiates a toggle button icon.
`.pf-v6-c-clipboard-copy__expandable-content`	`<div>`	Initiates an expandable element.
`.pf-v6-c-clipboard-copy__text`	`<span>`	Initiates the inline copy clipboard text element. Required
`.pf-v6-c-clipboard-copy__actions`	`<span>`	Initiates the inline copy clipboard actions element. Required
`.pf-v6-c-clipboard-copy__actions-item`	`<span>`	Initiates the inline copy clipboard actions item element. Required
`.pf-m-inline`	`.pf-v6-c-clipboard-copy`	Modifies the clipboard copy component for inline styles.
`.pf-m-block`	`.pf-v6-c-clipboard-copy.pf-m-inline`	Modifies the inline copy clipboard component to have block formatting.
`.pf-m-expanded`	`.pf-v6-c-clipboard-copy`	Modifies the clipboard copy component for the expanded state.
`.pf-m-expanded`	`.pf-v6-c-button.pf-m-control`	Modifies the control toggle button for the expanded state.
`.pf-m-code`	`code.pf-v6-c-clipboard-copy__text`	Modifies the inline copy clipboard text styles for use with the `<code>` element.

CSS variables

Expand or collapse column	Selector	Variable	Value
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__toggle-icon--Transition	.2s ease-in 0s
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy--m-expanded__toggle-icon--Rotate	90deg
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--MarginBlockStart	0.25rem
--pf-v6-c-clipboard-copy__expandable-content--MarginBlockStart --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--PaddingBlockStart	1rem
--pf-v6-c-clipboard-copy__expandable-content--PaddingBlockStart --pf-t--global--spacer--md --pf-t--global--spacer--300 1rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--PaddingInlineEnd	1rem
--pf-v6-c-clipboard-copy__expandable-content--PaddingInlineEnd --pf-t--global--spacer--md --pf-t--global--spacer--300 1rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--PaddingBlockEnd	1rem
--pf-v6-c-clipboard-copy__expandable-content--PaddingBlockEnd --pf-t--global--spacer--md --pf-t--global--spacer--300 1rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--PaddingInlineStart	1rem
--pf-v6-c-clipboard-copy__expandable-content--PaddingInlineStart --pf-t--global--spacer--md --pf-t--global--spacer--300 1rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BackgroundColor	(In light theme) #ffffff
--pf-v6-c-clipboard-copy__expandable-content--BackgroundColor --pf-t--global--background--color--primary--default --pf-t--global--background--color--100 --pf-t--color--white #ffffff
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderBlockStartWidth	1px
--pf-v6-c-clipboard-copy__expandable-content--BorderBlockStartWidth --pf-t--global--border--width--control--default --pf-t--global--border--width--100 1px
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderInlineEndWidth	1px
--pf-v6-c-clipboard-copy__expandable-content--BorderInlineEndWidth --pf-t--global--border--width--control--default --pf-t--global--border--width--100 1px
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderBlockEndWidth	1px
--pf-v6-c-clipboard-copy__expandable-content--BorderBlockEndWidth --pf-t--global--border--width--control--default --pf-t--global--border--width--100 1px
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderInlineStartWidth	1px
--pf-v6-c-clipboard-copy__expandable-content--BorderInlineStartWidth --pf-t--global--border--width--control--default --pf-t--global--border--width--100 1px
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderColor	(In light theme) #c7c7c7
--pf-v6-c-clipboard-copy__expandable-content--BorderColor --pf-t--global--border--color--default --pf-t--global--border--color--100 --pf-t--color--gray--30 #c7c7c7
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--BorderRadius	6px
--pf-v6-c-clipboard-copy__expandable-content--BorderRadius --pf-t--global--border--radius--small --pf-t--global--border--radius--200 6px
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__expandable-content--OutlineOffset	0.25rem
--pf-v6-c-clipboard-copy__expandable-content--OutlineOffset --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__group--Gap	0.25rem
--pf-v6-c-clipboard-copy__group--Gap --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy--m-inline--PaddingInlineStart	0.25rem
--pf-v6-c-clipboard-copy--m-inline--PaddingInlineStart --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy--m-inline--PaddingInlineEnd	0.25rem
--pf-v6-c-clipboard-copy--m-inline--PaddingInlineEnd --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy--m-inline--BackgroundColor	(In light theme) #f2f2f2
--pf-v6-c-clipboard-copy--m-inline--BackgroundColor --pf-t--global--background--color--secondary--default --pf-t--global--background--color--200 --pf-t--color--gray--10 #f2f2f2
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__actions--Gap	0.5rem
--pf-v6-c-clipboard-copy__actions--Gap --pf-t--global--spacer--sm --pf-t--global--spacer--200 0.5rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__actions--MarginInlineStart	0.25rem
--pf-v6-c-clipboard-copy__actions--MarginInlineStart --pf-t--global--spacer--xs --pf-t--global--spacer--100 0.25rem
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__actions-item--button--Color	(In light theme) #707070
--pf-v6-c-clipboard-copy__actions-item--button--Color --pf-t--global--icon--color--subtle --pf-t--global--icon--color--200 --pf-t--color--gray--50 #707070
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__actions-item--button--hover--Color	(In light theme) #1f1f1f
--pf-v6-c-clipboard-copy__actions-item--button--hover--Color --pf-t--global--icon--color--regular --pf-t--global--icon--color--100 --pf-t--color--gray--90 #1f1f1f
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__text--m-code--FontFamily	"Red Hat Mono", "RedHatMono", "Courier New", Courier, monospace
--pf-v6-c-clipboard-copy__text--m-code--FontFamily --pf-t--global--font--family--mono --pf-t--global--font--family--300 "Red Hat Mono", "RedHatMono", "Courier New", Courier, monospace
	:where(:root, .pf-v6-c-clipboard-copy)	--pf-v6-c-clipboard-copy__text--m-code--FontSize	0.875rem
--pf-v6-c-clipboard-copy__text--m-code--FontSize --pf-t--global--font--size--body--default --pf-t--global--font--size--sm --pf-t--global--font--size--200 0.875rem
	.pf-v6-c-clipboard-copy__actions-item .pf-v6-c-button.pf-m-plain	--pf-v6-c-button--m-plain__icon--Color	(In light theme) #707070
--pf-v6-c-button--m-plain__icon--Color --pf-v6-c-clipboard-copy__actions-item--button--Color --pf-t--global--icon--color--subtle --pf-t--global--icon--color--200 --pf-t--color--gray--50 #707070
	.pf-v6-c-clipboard-copy__actions-item .pf-v6-c-button.pf-m-plain	--pf-v6-c-button--m-plain--hover__icon--Color	(In light theme) #1f1f1f
--pf-v6-c-button--m-plain--hover__icon--Color --pf-v6-c-clipboard-copy__actions-item--button--hover--Color --pf-t--global--icon--color--regular --pf-t--global--icon--color--100 --pf-t--color--gray--90 #1f1f1f

View source on GitHub