open-consul/ui-v2/app/components/copy-button
2020-06-17 10:25:54 +01:00
..
chart.xstate.js ui: Token listing redesign (#8117) 2020-06-17 10:25:54 +01:00
index.hbs ui: Token listing redesign (#8117) 2020-06-17 10:25:54 +01:00
index.js ui: Token listing redesign (#8117) 2020-06-17 10:25:54 +01:00
README.mdx ui: Renames CopyButtonFeedback to CopyButton and use it everywhere (#7834) 2020-05-12 17:14:56 +00:00

## CopyButton

```handlebars
{{! inline }}
<CopyButton
  @value={{stringToCopy}}
  @name="Thing"
/>

<CopyButton
  @value={{stringToCopy}}
  @name="Thing"
>
  Copy me!
</CopyButton>
```

### Arguments

| Argument | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `String` | | The string to be copied to the clipboard on click |
| `name` | `String` | | The 'Name' of the string to be copied. Mainly used for giving feedback to the user |

This component renders a simple button, when clicked copies the value (the `@value` attribute) to the users clipboard. A simple piece of feedback is given to the user in the form of a tooltip. When used inline an empty button is rendered.

### See

- [Component Source Code](./index.js)
- [Template Source Code](./index.hbs)

---