Since Shoelace 2.7 Code experimental

Copy Button

sl-copy-button

Copies text data to the clipboard when the user clicks the trigger.

Examples

Basic Copy Button 

<sl-copy-button value="Shoelace rocks!"></sl-copy-button>

Custom Labels

Copy Buttons display feedback in a tooltip. You can customize the labels using the copy-label, success-label, and error-label attributes. 

<sl-copy-button
  value="Custom labels are easy"
  copy-label="Click to copy"
  success-label="You did it!"
  error-label="Whoops, your browser doesn't support this!"
></sl-copy-button>

Custom Icons

Use the copy-icon, success-icon, and error-icon slots to customize the icons that get displayed for each state. You can use <sl-icon> or your own images. 

<sl-copy-button value="Copied from a custom button">
  <sl-icon slot="copy-icon" name="clipboard"></sl-icon>
  <sl-icon slot="success-icon" name="clipboard-check"></sl-icon>
  <sl-icon slot="error-icon" name="clipboard-x"></sl-icon>
</sl-copy-button>

Copying Values From Other Elements

Normally, the data that gets copied will come from the component’s value attribute, but you can copy data from any element within the same document by providing its id to the from attribute.

When using the from attribute, the element’s textContent will be copied by default. Passing an attribute or property modifier will let you copy data from one of the element’s attributes or properties instead.

To copy data from an attribute, use from="id[attr]" where id is the id of the target element and attr is the name of the attribute you’d like to copy. To copy data from a property, use from="id.prop" where id is the id of the target element and prop is the name of the property you’d like to copy.

+1 (234) 456–7890



Shoelace Website 
<!-- Copies the span's textContent -->
<span id="my-phone">+1 (234) 456-7890</span>
<sl-copy-button from="my-phone"></sl-copy-button>

<br><br>

<!-- Copies the input's "value" property -->
<sl-input id="my-input" type="text" value="User input" style="display: inline-block; max-width: 300px;"></sl-input>
<sl-copy-button from="my-input.value"></sl-copy-button>

<br><br>

<!-- Copies the link's "href" attribute -->
<a id="my-link" href="https://shoelace.style/">Shoelace Website</a>
<sl-copy-button from="my-link[href]"></sl-copy-button>

Handling Errors

A copy error will occur if the value is an empty string, if the from attribute points to an id that doesn’t exist, or if the browser rejects the operation for any reason. When this happens, the sl-error event will be emitted.

This example demonstrates what happens when a copy error occurs. You can customize the error label and icon using the error-label attribute and the error-icon slot, respectively. 

<sl-copy-button from="i-do-not-exist"></sl-copy-button>

Disabled

Copy buttons can be disabled by adding the disabled attribute.

<sl-copy-button value="You can't copy me" disabled></sl-copy-button>

Changing Feedback Duration

A success indicator is briefly shown after copying. You can customize the length of time the indicator is shown using the feedback-duration attribute. 

<sl-copy-button value="Shoelace rocks!" feedback-duration="250"></sl-copy-button>

Custom Styles

You can customize the button to your liking with CSS.

<sl-copy-button value="I'm so stylish" class="custom-styles">
  <sl-icon slot="copy-icon" name="asterisk"></sl-icon>
  <sl-icon slot="success-icon" name="check-lg"></sl-icon>
  <sl-icon slot="error-icon" name="x-lg"></sl-icon>
</sl-copy-button>

<style>
  .custom-styles {
    --success-color: white;
    --error-color: white;
    color: white;
  }

  .custom-styles::part(button) {
    background-color: #ff1493;
    border: solid 4px #ff7ac1;
    border-right-color: #ad005c;
    border-bottom-color: #ad005c;
    border-radius: 0;
    transition: 100ms scale ease-in-out, 100ms translate ease-in-out;
  }

  .custom-styles::part(button):hover {
    scale: 1.1;
  }

  .custom-styles::part(button):active {
    translate: 0 2px;
  }

  .custom-styles::part(button):focus-visible {
    outline: dashed 2px deeppink;
    outline-offset: 4px;
  }
</style>

Component Props

Property Default Details
value ''

string

The text value to copy.
from ''

string

An id that references an element in the same document from which data will be copied. If both this and value are present, this value will take precedence. By default, the target element’s textContent will be copied. To copy an attribute, append the attribute name wrapped in square brackets, e.g. from="el[value]". To copy a property, append a dot and the property name, e.g. from="el.value".

disabled false

boolean

Disables the copy button.
copyLabel
copy-label 		''

string

A custom label to show in the tooltip.
successLabel
success-label 		''

string

A custom label to show in the tooltip after copying.
errorLabel
error-label 		''

string

A custom label to show in the tooltip when a copy error occurs.
feedbackDuration
feedback-duration 		1000

number

The length of time to show feedback before restoring the default trigger.
tooltipPlacement
tooltip-placement 		'top'

'top' | 'right' | 'bottom' | 'left'

The preferred placement of the tooltip.
hoist false

boolean

Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with overflow: auto|hidden|scroll. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.

updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Slots

Name Details
copy-icon The icon to show in the default copy state. Works best with <sl-icon>.
success-icon The icon to show when the content is copied. Works best with <sl-icon>.
error-icon The icon to show when a copy error occurs. Works best with <sl-icon>.

Learn more about using slots.

Events

Name Name Name React Event Details
sl-copy sl-copy sl-copy onSlCopy

Emitted when the data has been copied.
sl-error sl-error sl-error onSlError

Emitted when the data could not be copied.

Learn more about events.

Custom Properties

Name Details
--success-color

The color to use for success feedback.
--error-color

The color to use for error feedback.

Learn more about customizing CSS custom properties.

CSS Parts

Name Description
button The internal <button> element.
copy-icon The container that holds the copy icon.
success-icon The container that holds the success icon.
error-icon The container that holds the error icon.
tooltip__base The tooltip’s exported base part.
tooltip__base__popup The tooltip’s exported popup part.
tooltip__base__arrow The tooltip’s exported arrow part.
tooltip__body The tooltip’s exported body part.

Learn more about customizing CSS parts.

Animations

Name Description
copy.in The animation to use when feedback icons animate in.
copy.out The animation to use when feedback icons animate out.

Learn more about customizing animations.

Dependencies

This component automatically imports the following dependencies.

  • <sl-icon>
  • <sl-popup>
  • <sl-tooltip>