# Copy to Clipboard

{% embed url="<https://youtu.be/iypmU5492OQ?si=I9qTrLrs-XPyRiGe>" %}

Watch this on Youtube: <https://www.youtube.com/watch?v=iypmU5492OQ>

The **Copy to Clipboard** action copies text content to the device's clipboard, making it available for pasting in other apps or fields. This is commonly used for sharing codes, links, or generated content.

***

***

#### 📦 Properties

| Property  | Type                | Required | Description                           |
| --------- | ------------------- | -------- | ------------------------------------- |
| `message` | Expression (String) | ✅        | The text content to copy to clipboard |

#### ✅ Common Use Cases

* Copying referral codes, promo codes, or invite links
* Copying generated passwords or tokens
* Copying text from form fields for reuse
* Sharing user IDs, transaction IDs, or confirmation codes
* Copying dynamic content from API responses

***

#### ⚙️ Default Behavior

By default:

| Behavior                   | Description                                                    |
| -------------------------- | -------------------------------------------------------------- |
| **Toast Notification**     | Shows "Copied to Clipboard!" success message (dashboard only)  |
| **Error Handling**         | Shows "Failed to copy to clipboard." on error (dashboard only) |
| **Empty Message Handling** | Gracefully handles null/empty messages without error           |
| **Platform Support**       | Works on all platforms supported by Flutter                    |

***

#### 🛠️ How to Use

1. Add the action to a widget event (e.g., button tap, text selection)
2. Choose **Copy to Clipboard** from the action list
3. Set the `message` property to the text you want to copy

<figure><img src="https://3626461507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbhApDTL7kHrXte2TTtjs%2Fuploads%2Fgit-blob-c0a02267efe14e6c2d431889664fa580d3bf8cd3%2Fcopy_to_clipboard_action.png?alt=media" alt="Call External Method action configuration showing message name and payload fields"><figcaption><p>Call External Method action configuration in Digia Studio</p></figcaption></figure>

***