mirror of https://github.com/hashicorp/consul
46 lines
1.3 KiB
Plaintext
46 lines
1.3 KiB
Plaintext
|
# ConsulCopyButton
|
||
|
|
|
||
|
|
Button component used for copy-to-clipboard functionality so the user can easily copy specified text to their clipboard, along with tooltip-like notifications so the user has some sort of feedback to know the value has been copied.
|
||
|
|
|
||
|
|
This component is essentially a composition of our `{{with-copyable}}` modifier, our `{{tooltip}}` modifier plus specific Consul-flavored visual treatment. This is all glued together with our `<StateChart />` component to manage states.
|
||
|
|
|
||
|
|
Can be used inline to render only a small icon for the button with no other text.
|
||
|
|
|
||
|
|
```hbs preview-template
|
||
|
|
<figure>
|
||
|
|
<figcaption>Icon only</figcaption>
|
||
|
|
|
||
|
|
<ConsulCopyButton
|
||
|
|
@value={{'stringToCopy'}}
|
||
|
|
@name="Thing"
|
||
|
|
/>
|
||
|
|
|
||
|
|
</figure>
|
||
|
|
|
||
|
|
<figure>
|
||
|
|
<figcaption>Icon and text</figcaption>
|
||
|
|
|
||
|
|
<ConsulCopyButton
|
||
|
|
@value={{'stringToCopy'}}
|
||
|
|
@name="Thing"
|
||
|
|
>
|
||
|
|
Copy me!
|
||
|
|
</ConsulCopyButton>
|
||
|
|
</figure>
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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 accessibility reasons and giving feedback to the user |
|
||
|
|
|
||
|
|
|
||
|
|
## See
|
||
|
|
|
||
|
|
- [Component Source Code](./index.js)
|
||
|
|
- [Template Source Code](./index.hbs)
|
||
|
|
|
||
|
|
---
|