open-consul/ui/packages/consul-ui/app/components/copy-button
John Cowen d47ccb859f
ui: Improves UI engineering docs (#9875)
Also fixes some typos in with-overlay
2021-03-17 15:58:17 +00:00
..
chart.xstate.js ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
index.hbs ui: Modifier based tooltips (#9288) 2020-11-30 16:52:13 +00:00
index.js ui: Modifier based tooltips (#9288) 2020-11-30 16:52:13 +00:00
README.mdx ui: Improves UI engineering docs (#9875) 2021-03-17 15:58:17 +00:00

# CopyButton

```hbs preview-template
<p>
  Icon Only:
</p>
<CopyButton
  @value={{stringToCopy}}
  @name="Thing"
/>

<p>
  Icon and text:
</p>
<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)

---