luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/ui/packages/consul-ui/app/components/copy-button/README.mdx

38 lines
832 B
Plaintext
Raw Normal View History

ui: Remove storybook, add docfy (#9831) This PR removes storybook and adds docfy and uses docfy to render our existing README files. This now means we can keep adding README documentation without committing any specific format or framework. If we eventually move to storybook then fine, or if we just want to remove docfy for whatever reason then fine - we will still have a full set of README files viewable via GitHub.
2021-03-08 12:22:01 +00:00
# CopyButton
ui: Renames CopyButtonFeedback to CopyButton and use it everywhere (#7834) * ui: Renames CopyButtonFeedback to CopyButton and use it everywhere * Uncapitalize output * Remove the ability to set the contents via an attr, and.. ..change the attribute for the string that gets copied to be called 'value' so it feels like HTML
2020-05-12 12:36:03 +00:00
ui: Remove storybook, add docfy (#9831) This PR removes storybook and adds docfy and uses docfy to render our existing README files. This now means we can keep adding README documentation without committing any specific format or framework. If we eventually move to storybook then fine, or if we just want to remove docfy for whatever reason then fine - we will still have a full set of README files viewable via GitHub.
2021-03-08 12:22:01 +00:00
```hbs preview-template
ui: Improves UI engineering docs (#9875) Also fixes some typos in with-overlay
2021-03-17 15:58:17 +00:00
<p>
Icon Only:
</p>
ui: Renames CopyButtonFeedback to CopyButton and use it everywhere (#7834) * ui: Renames CopyButtonFeedback to CopyButton and use it everywhere * Uncapitalize output * Remove the ability to set the contents via an attr, and.. ..change the attribute for the string that gets copied to be called 'value' so it feels like HTML
2020-05-12 12:36:03 +00:00
<CopyButton
@value={{stringToCopy}}
@name="Thing"
/>
ui: Improves UI engineering docs (#9875) Also fixes some typos in with-overlay
2021-03-17 15:58:17 +00:00
<p>
Icon and text:
</p>
ui: Renames CopyButtonFeedback to CopyButton and use it everywhere (#7834) * ui: Renames CopyButtonFeedback to CopyButton and use it everywhere * Uncapitalize output * Remove the ability to set the contents via an attr, and.. ..change the attribute for the string that gets copied to be called 'value' so it feels like HTML
2020-05-12 12:36:03 +00:00
<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)
---