ClipboardCopyButton
The `ClipboardCopy` component styled as a Primer button.
On this page
Description
ClipboardCopyButton
uses the ClipboardCopy
component to copy text to the clipboard,
styled as a Primer button. It can be used wherever a button is desired, and works well
with components like ButtonGroup
.
Arguments
Name | Default | Description |
---|---|---|
system_arguments | N/A | Hash The arguments accepted by Button and ClipboardCopy. |
Examples
Slots
leading_visual
Leading visuals appear to the left of the button text.
Use:
-
leading_visual_icon
for a Octicon. -
leading_visual_svg
to render a SVG.
Name | Default | Description |
---|---|---|
system_arguments | N/A | Hash Same arguments as Octicon. |
trailing_visual
Trailing visuals appear to the right of the button text.
Use:
trailing_visual_counter
for a Counter.
Name | Default | Description |
---|---|---|
system_arguments | N/A | Hash Same arguments as Counter. |
trailing_action
Trailing action appears to the right of the trailing visual.
Use:
trailing_action_icon
for a Octicon.
Name | Default | Description |
---|---|---|
system_arguments | N/A | Hash Same arguments as Octicon. |
tooltip
Tooltip
that appears on mouse hover or keyboard focus over the button. Use tooltips sparingly and as a last resort.
Important: This tooltip defaults to type: :description
. In a few scenarios, type: :label
may be more appropriate.
Consult the Tooltip documentation for more information.
Name | Default | Description |
---|---|---|
type |
| Symbol One of |
system_arguments | N/A | Hash Same arguments as Tooltip. |