IClipboardProps

interface
Action & Command

Props for <OrigamClipboard> — a chrome-less copy-to-clipboard wrapper. Owns the copy pipeline (navigator.clipboard.writeText + execCommand fallback) and the auto-resetting copied flag. The built-in trigger is a single button; consumers can pass a #default scoped slot for full control.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

value
required
string
Text payload written to the clipboard on copy(). Re-read on each trigger so mutated values are always current.
feedbackDuration
number
2000
Duration (ms) the copied flag stays true after a successful write. Auto-resets — no manual clearing needed.
feedbackText
string
'Copied!'
Label rendered inside the built-in feedback overlay and the auto-rendered button label when no slot is provided.
successText
string
Alias for feedbackText. Takes precedence when both are passed.
icon
TIcon
copiedIcon
TIcon
disabled
boolean
false
Disables the copy action. The default trigger becomes non-interactive and copy() becomes a no-op.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Basic copy button with custom feedback text

vue