Clipboard

A component to copy text to the clipboard

Copy this link

Anatomy

To set up the Clipboard correctly, you'll need to understand its anatomy and how we name its parts.

Each part includes a data-part attribute to help identify them in the DOM.

Examples

Learn how to use the Clipboard component in your project. Let's take a look at the most basic example:

Example not found

Example not found

Example not found

Example not found

Using Context

Access the clipboard state and methods using Clipboard.Context. This provides access to properties like copied, value, and setValue

Alternatively, you can use the useClipboardContext hook to access the clipboard context.

Example not found

Example not found

Example not found

Example not found

Copy Status

Use the onStatusChange prop to listen for copy operations. It exposes a copied property that you can use to display a success message.

Example not found

Example not found

Example not found

Example not found

Controlled

Control the clipboard value externally by managing the state yourself and using onValueChange to handle updates.

Example not found

Example not found

Example not found

Example not found

Root Provider

Use the useClipboard hook to create the clipboard store and pass it to the Clipboard.RootProvider component. This allows you to have maximum control over the clipboard programmatically.

If you're using the Clipboard.RootProvider component, you don't need to use the Clipboard.Root component.

Example not found

Example not found

Example not found

Example not found

Custom Timeout

Configure the copy status timeout duration using the timeout prop. Default is 3000ms (3 seconds).

Example not found

Example not found

Example not found

Example not found

Programmatic Copy

Trigger copy operations programmatically using the context's copy() method.

Example not found

Example not found

Example not found

Example not found

Value Text

Use Clipboard.ValueText to display the current clipboard value.

Example not found

Example not found

Example not found

Example not found

API Reference

Props

Root

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`defaultValue`		`string` The initial value to be copied to the clipboard when rendered. Use when you don't need to control the value of the clipboard.
`id`		`string` The unique identifier of the machine.
`ids`		`Partial<{ root: string; input: string; label: string }>` The ids of the elements in the clipboard. Useful for composition.
`onStatusChange`		`(details: CopyStatusDetails) => void` The function to be called when the value is copied to the clipboard
`onValueChange`		`(details: ValueChangeDetails) => void` The function to be called when the value changes
`timeout`	`3000`	`number` The timeout for the copy operation
`value`		`string` The controlled value of the clipboard

Data Attribute	Value
`[data-scope]`	clipboard
`[data-part]`	root
`[data-copied]`	Present when copied state is true

Control

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Data Attribute	Value
`[data-scope]`	clipboard
`[data-part]`	control
`[data-copied]`	Present when copied state is true

Indicator

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`copied`		`string \| number \| bigint \| boolean \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<...>`

Input

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Data Attribute	Value
`[data-scope]`	clipboard
`[data-part]`	input
`[data-copied]`	Present when copied state is true
`[data-readonly]`	Present when read-only

Label

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Data Attribute	Value
`[data-scope]`	clipboard
`[data-part]`	label
`[data-copied]`	Present when copied state is true

RootProvider

Prop	Default	Type
`value`		`UseClipboardReturn`
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Trigger

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Data Attribute	Value
`[data-scope]`	clipboard
`[data-part]`	trigger
`[data-copied]`	Present when copied state is true

ValueText

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Context

These are the properties available when using Clipboard.Context, useClipboardContext hook or useClipboard hook.

API

Property	Type
`copied`	`boolean` Whether the value has been copied to the clipboard
`value`	`string` The value to be copied to the clipboard
`setValue`	`(value: string) => void` Set the value to be copied to the clipboard
`copy`	`VoidFunction` Copy the value to the clipboard