mirror of https://github.com/hashicorp/consul
38 lines
832 B
Markdown
38 lines
832 B
Markdown
# 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)
|
|
|
|
---
|