---
title: ClipboardItem
description: Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `<s-clipboard-item>` doesn’t render visually.
api_version: 2026-01
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/utilities/clipboarditem
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/utilities/clipboarditem.md
---

# Clipboard​Item

Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `<s-clipboard-item>` doesn’t render visually.

## Properties

* **id**

  **string**

  A unique identifier for the element.

* **text**

  **string**

  **Default: ''**

  Plain text to be written to the clipboard.

## Events

Learn more about [registering events](https://shopify.dev/docs/api/checkout-ui-extensions/2026-01/using-polaris-components#event-handling).

* **copy**

  **CallbackEventListener\<typeof tagName>**

  Callback run when the copy to clipboard succeeds.

* **copyerror**

  **CallbackEventListener\<typeof tagName>**

  Callback run when the copy to clipboard fails.

### CallbackEventListener

```ts
(EventListener & {
    (event: CallbackEvent<TTagName, Event> & TData): void;
}) | null
```

### CallbackEvent

```ts
TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}
```

Examples

## Preview

![](https://shopify.dev/images/templated-apis-screenshots/checkout-ui-extensions/2026-01/clipboard-item-default.png)

### Examples

* #### Code

  ##### Default

  ```html
  <s-button commandFor="discount-code">Copy discount code</s-button>
  <s-clipboard-item id="discount-code" text="SAVE 25"></s-clipboard-item>
  ```