Skip to content

Commit 4afcda1

Browse files
docs(clipboard-copy): Updates design guidelines for accuracy. (#4615)
* docs(clipboard-copy): Updates design guidelines for accuracy. * Removes old images. --------- Co-authored-by: Andrew Ronaldson <aronalds@redhat.com>
1 parent cb74fdb commit 4afcda1

11 files changed

Lines changed: 33 additions & 31 deletions

File tree

packages/documentation-site/patternfly-docs/content/design-guidelines/components/clipboard-copy/clipboard-copy.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,71 +12,73 @@ Clipboard copy has 3 main components.
1212
![Elements of the clipboard copy component.](./img/clipboard-copy-elements.svg)
1313
</div>
1414

15-
1. **Copy content:** the content that will be copied to the user’s clipboard.
16-
2. **Clipboard button:** completes the copy action when clicked.
17-
3. **Tooltip:** informs users that clicking the button will copy the content to their clipboard, or that the content has successfully been copied.
15+
1. **Copy content:** The content that will be copied to the user’s clipboard.
16+
2. **Clipboard button:** Completes the copy action when clicked.
17+
3. **Tooltip:** Informs users that clicking the button will copy the content to their clipboard. Once a user has clicked this button, this tooltip will update to convey success.
1818

1919
## Usage
20-
Use clipboard copy to allow users to quickly and easily copy content to their clipboard to paste it in another location. Copy content can vary but is usually a line or block of text or code. This is useful for copying system generated key values, to both reduce user effort and the occurrence of entry errors, for example. The clipboard copy has a few features that can be used to customize the component to fit different use cases.
20+
Use clipboard copy to allow users to quickly and easily copy content to their clipboard to paste it in another location. Copy content can vary but is usually a line or block of text or code. This is useful for copying system generated key values, to both reduce user effort and the occurrence of entry errors, for example.
2121

22-
### Features
23-
The clipboard copy component can be editable or read-only and both types can optionally be expandable.
24-
25-
**Editable**
22+
### Examples
23+
Clipboard copy can be used almost anywhere in a UI. It is commonly used in forms and definition lists.
2624

27-
An editable clipboard copy allows users to copy an editable text input box.
25+
**Clipboard copy in a form**
2826

2927
<div class="ws-docs-content-img">
30-
![Example of an editable clipboard copy component.](./img/clipboard-copy-editable.svg)
28+
![Example of clipboard copy in a form.](./img/clipboard-copy-form.svg)
3129
</div>
3230

33-
**Read-only**
34-
35-
A read-only clipboard copy only allows the user to copy a predefined line of text that is not editable by the user.
31+
**Clipboard copy in a description list**
3632

3733
<div class="ws-docs-content-img">
38-
![Example of a read-only clipboard copy component.](./img/clipboard-copy-readonly.svg)
34+
![Example of clipboard copy in a description list.](./img/clipboard-copy-description-list.svg)
3935
</div>
4036

41-
**Expandable**
42-
43-
An expandable clipboard copy allows for long lines of text to be stored in an expansion panel. Expanding the clipboard copy allows the user to view the full string that they can copy.
37+
**Inline compact clipboard copy in context**
4438

4539
<div class="ws-docs-content-img">
46-
![Example of an expandable clipboard copy component.](./img/clipboard-copy-expandable.svg)
40+
![Example of an inline compact clipboard copy in context.](./img/clipboard-copy-inline-compact-4.svg)
4741
</div>
4842

49-
**Inline compact**
43+
## Variations
44+
The clipboard copy component has a few features that can be used to customize the component to fit different use cases. For example, it can be editable or read-only, with options for expansion.
5045

51-
An inline compact clipboard copy is placed directly inline with other text or used on its own when you want a lighter weight clipboard copy treatment.
46+
### Editable
47+
48+
An editable clipboard copy allows users to edit the text input. Their edited text will be copied when the clipboard button is clicked.
5249

5350
<div class="ws-docs-content-img">
54-
![Example of an inline clipboard copy component with one action.](./img/clipboard-copy-inline-compact-1.svg)
51+
![Example of an editable clipboard copy component.](./img/clipboard-copy-editable.svg)
5552
</div>
5653

57-
An inline compact clipboard copy can include one or two action buttons next to it. The second action is customizable and optional.
54+
### Read-only
55+
56+
A read-only clipboard copy only allows the user to copy a predefined line of text that is not editable by the user.
5857

5958
<div class="ws-docs-content-img">
60-
![Example of an inline clipboard copy component with two actions.](./img/clipboard-copy-inline-compact-2.svg)
59+
![Example of a read-only clipboard copy component.](./img/clipboard-copy-readonly.svg)
6160
</div>
6261

63-
### Clipboard copy in context
64-
Clipboard copy can be used almost anywhere in a UI. It is commonly used in forms and definition lists.
62+
### Expandable
6563

66-
**Clipboard copy in a form**
64+
An expandable clipboard copy allows for long lines of text to be stored in an expansion panel. Expanding the clipboard copy allows the user to view the full string that they can copy.
6765

6866
<div class="ws-docs-content-img">
69-
![Example of clipboard copy in a form.](./img/clipboard-copy-form.svg)
67+
![Example of an expandable clipboard copy component.](./img/clipboard-copy-expandable.svg)
7068
</div>
7169

72-
**Clipboard copy in a description list**
70+
When collapsed, users can edit the text input. When expanded, the text input becomes read-only and users can instead edit the text in the expansion panel.
71+
72+
### Inline compact
73+
74+
An inline compact clipboard copy is placed directly inline with other text or used on its own when you want a lighter weight clipboard copy treatment.
7375

7476
<div class="ws-docs-content-img">
75-
![Example of clipboard copy in a description list.](./img/clipboard-copy-description-list.svg)
77+
![Example of an inline clipboard copy component with one action.](./img/clipboard-copy-inline-compact-1.svg)
7678
</div>
7779

78-
**Inline compact clipboard copy in context**
80+
An inline compact clipboard copy can include 1 or 2 action buttons next to it. The second action is customizable and optional.
7981

8082
<div class="ws-docs-content-img">
81-
![Example of an inline compact clipboard copy in context.](./img/clipboard-copy-inline-compact-4.svg)
83+
![Example of an inline clipboard copy component with two actions.](./img/clipboard-copy-inline-compact-2.svg)
8284
</div>

0 commit comments

Comments
 (0)