@georapbox/clipboard-copy-element

<clipboard-copy>

A custom element that implements the Clipboard API to copy text content from elements or input values to the clipboard.

API documentation • Demo

Install

$ npm install --save @georapbox/clipboard-copy-element

Usage

Script

import { ClipboardCopy } from './node_modules/@georapbox/clipboard-copy-element/dist/clipboard-copy.js';

// Manually define the element.
ClipboardCopy.defineCustomElement();

Alternatively, you can import the automatically defined custom element.

import './node_modules/@georapbox/clipboard-copy-element/dist/clipboard-copy-defined.js';

Markup

<clipboard-copy value="Text to copy"></clipboard-copy>

Style

By default, the component is style-free to remain as less opinionated as possible. However, you can style the various elements of the component using the ::part() CSS pseudo-elements provided for this purpose. Below are demonstrated all available parts for styling.

clipboard-copy::part(button) {
  /* The button element */
}

clipboard-copy::part(button--disabled) {
  /* The button element - disabled state */
}

clipboard-copy::part(button--success) {
  /* The button element - success state */
}

clipboard-copy::part(button--error) {
  /* The button element - error state */
}

API

Properties

Name	Reflects	Type	Default	Description
value	✓	String	null	Optional. The value to be copied to clipboard.
from	✓	String	null	Optional. A valid CSS selector string to target the first element within the document that matches this selector. If the element is HTMLInputElement or HTMLTextAreaElement the value attribute of the element will be copied. If the element is HTMLAnchorElement the href attribute of the element will be copied. In any other case, the textContent of the element will be copied. If both value and from properties are set, the value property will take precedence over the from property.
disabled	✓	Boolean	false	Optional. Defines if the copy button is disabled.
feedbackDuration feedback-duration	✓	Number	1000	The duration (in milliseconds) that the feedback is displayed before restoring the default button's content.

All of the above properties reflect their values as HTML attributes to keep the element's DOM representation in sync with its JavaScript state.

Slots

Name	Default	Description
copy	"Copy"	Override the button's default content. Example: <span slot="copy">Copy text</span>
success	"Copied!"	Override the button's feedback for success. Example: <span slot="success">Copied successfully!</span>
error	"Error"	Override the button's feedback for error. Example: <span slot="error">Could not copy!</span>

CSS Parts

Name	Description
button	Represents the button element.
button--disabled	Represents the disabled state of the button.
button--success	Represents the success state of the button.
button--error	Represents the error state of the button.

Events

Name	Description	Event Detail
clipboard-copy-success	Emitted when copy is successful.	{ value: String }
clipboard-copy-error	Emitted when copy fails for any reason.	{ error: DOMException }

Changelog

For API updates and breaking changes, check the CHANGELOG.

License

The MIT License (MIT)