Skip to content

Commit 1fc0c87

Browse files
authored
docs(truncate): Updates truncation design guidelines. (#4916)
* docs(truncate): Updates truncation design guidelines. * Fix typo and update a couple of spacing things. * Update images.
1 parent df1af96 commit 1fc0c87

File tree

6 files changed

+106
-47
lines changed

6 files changed

+106
-47
lines changed

packages/documentation-site/patternfly-docs/content/components/truncate/img/end-line.svg

Lines changed: 5 additions & 5 deletions
Loading

packages/documentation-site/patternfly-docs/content/components/truncate/img/front-line.svg

Lines changed: 5 additions & 5 deletions
Loading

packages/documentation-site/patternfly-docs/content/components/truncate/img/mid-line.svg

Lines changed: 5 additions & 5 deletions
Loading

packages/documentation-site/patternfly-docs/content/components/truncate/img/truncate.svg

Lines changed: 36 additions & 0 deletions
Loading

packages/documentation-site/patternfly-docs/content/components/truncate/truncate.md

Lines changed: 54 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,55 +6,78 @@ section: components
66
import '../components.css';
77

88
## Elements
9-
* **Content**: text string to truncate
10-
* **Position**: where the text will be truncated from, ie. front, middle, or end
11-
* **Tooltip hover**: displayes full-text string
12-
* **Ellipsis**: indicates a truncate is used
9+
10+
<div class="ws-docs-content-img">
11+
![A text input field containing a string truncated in the middle with an ellipsis. A black tooltip below shows the full text string.](./img/truncate.svg)
12+
</div>
13+
14+
1. **Content:** A long text string that requires truncation.
15+
2. **Ellipsis:** The truncation indicator (...) placed at the start, middle, or end of a string, depending on the [variation](#variations).
16+
3. **Tooltip:** The message shown on hover to display the full text string.
1317

1418
## Usage
15-
Truncated items are indicated by an ellipsis (...) and are used when trying to avoid multiple lines of text or when a container is being overflowed by content. Truncation should only be used when 3 or more characters are being represented and there are still at least 4 non-truncated characters displayed. Truncated items should always include a tooltip on hover, showcasing the full string sequence.
16-
* **Breadcrumbs**: Use a breadcrumbs truncate when there isn’t enough room to display the entire breadcrumbs list, or as a way of managing relevance.
19+
Truncated items are indicated by an ellipsis (...) and are used to reduce multiple lines of text or when a container is being overflowed by content. Truncation should only be used when 3 or more characters are being represented and there are still at least 4 non-truncated characters displayed.
20+
21+
Truncated items should always include a tooltip on hover, showcasing the full string sequence.
22+
23+
### Breadcrumbs
24+
Use a breadcrumbs truncate when there isn’t enough room to display the entire breadcrumbs list, or to manage relevance.
1725

18-
<div class="ws-docs-content-img">![image showing breadcrumbs truncation](./img/breadcrumb-truncate.svg)</div>
26+
<div class="ws-docs-content-img">
27+
![A row of text strings separated by right-angle carets. Between the first two strings, an ellipsis replaces text, and a black tooltip displays "Breadcrumb 2 Breadcrumb 3" to show the truncated items.](./img/breadcrumb-truncate.svg)
28+
</div>
1929

20-
* **Long URL's**: Use a URL truncate when the url overflows its container.
30+
### Long URLs
31+
Use a URL truncate when the URL overflows its container.
2132

22-
<div class="ws-docs-content-img">![image showing long url truncation](./img/long-url.svg)</div>
33+
<div class="ws-docs-content-img">
34+
![A URL path truncated in the middle by an ellipsis. A black tooltip is displayed above the path showing the full URL.](./img/long-url.svg)
35+
</div>
2336

24-
* **Description text/alerts**: Use a truncate for description text to create more room on the page.
37+
### Description text/alerts
38+
Use a truncate for description text to create more room on the page.
2539

26-
<div class="ws-docs-content-img">![image showing alert truncation](./img/text-alerts.svg)</div>
40+
<div class="ws-docs-content-img">
41+
![Two alert components, one with a title that is truncated at the end with an ellipsis, and one where the description is truncated.](./img/text-alerts.svg)
42+
</div>
2743

28-
* **Table inputs**: Use truncation when the data within a table overflows its container.
44+
### Table inputs
45+
Use truncation when the data within a table overflows its container. If a table column is resizable, the truncated text should adjust accordingly.
2946

30-
<div class="ws-docs-content-img">![image showing table truncation](./img/table-truncate.svg)</div>
47+
<div class="ws-docs-content-img">
48+
![A data table where one column contains truncated text. An ellipsis appears at the end of the cell content to indicate it has been shortened, and a tooltip displays the full context.](./img/table-truncate.svg)
49+
</div>
3150

3251
## Behavior
33-
A truncate indicates that the text string has been shortened, when the user hovers a mouse over the ellipsis, the full text will be displayed as a tooltip.
52+
A truncate component indicates that a text string has been shortened. When a user hovers over truncated text, the full text will be displayed as a tooltip.
3453

3554
## Variations
3655

37-
### Front-line
38-
A front-line truncate is used at the beginning of a text string to indicate the text is being continued from a previous location.
56+
### Default (end)
57+
The default truncate is used at the end of a text string to shorten the sequence and indicate that there is more content located elsewhere.
3958

40-
<div class="ws-docs-content-img">![image showing truncation at the start of a text string](./img/front-line.svg)</div>
59+
<div class="ws-docs-content-img">
60+
![A text string where the last several characters are replaced by an ellipsis at the end of the line.](./img/end-line.svg)
61+
</div>
4162

42-
### Mid-line
43-
A mid-line truncate is used to shorten a text string when the end of it can’t be truncated by an ellipsis. Also used when several text strings have the exact same middle characters, but the beginning and endings vary.
63+
### Start
64+
A start truncate is used at the beginning of a text string to indicate the text is being continued from a previous location.
4465

45-
<div class="ws-docs-content-img">![image showing truncation at the middle of a text string](./img/mid-line.svg)</div>
66+
<div class="ws-docs-content-img">
67+
![A text string where the beginning characters are replaced by an ellipsis, while the end of the string remains visible.](./img/front-line.svg)
68+
</div>
4669

47-
### End-line
48-
An end-line truncate is used at the end of a text string to shorten the sequence and indicate that there is more content located elsewhere.
70+
### Middle
71+
A middle truncate is used to shorten a text string when the end of it can’t be truncated by an ellipsis. Also used when several text strings have the exact same middle characters, but the beginning and endings vary.
4972

50-
<div class="ws-docs-content-img">![image showing truncation at the end of a text string](./img/end-line.svg)</div>
73+
<div class="ws-docs-content-img">
74+
![A text string where an ellipsis is placed in the center, keeping both the start and the end of the string visible.](./img/mid-line.svg)
75+
</div>
5176

5277
## Content considerations
53-
* If the text string is part of a link, the ellipsis should also be a part of the link.
54-
* Always include hover tooltip to display the entire string to the user.
55-
* Avoid abbreviations or truncated text in navigation items.
56-
* Truncate text within tables where the content overflows the container. Avoid truncating table headings.
57-
* When truncating text, aim to leave at least four characters un-truncated so the user understands what it is (for example, don’t truncate “demo1.internal-el6satelite” to “de…”).
58-
* Truncate long item names if necessary.
59-
* Avoid truncation directly before or after punctuation.
60-
* If a table column is resizable, the truncated text should adjust accordingly.
78+
- Include the ellipsis as part of a link when the truncated text is a link.
79+
- Always provide a tooltip to display the entire string to the user upon hover.
80+
- Avoid truncating navigation items.
81+
- Truncate text within tables when it overflows the cell, but avoid truncating table headings.
82+
- Maintain at least 4 visible characters so users can better understand content (for example, don’t truncate “demo1.internal-el6satellite” to “de…”).
83+
- Avoid placing truncation directly before or after punctuation.

packages/documentation-site/patternfly-docs/content/content-design/grammar/truncation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: content-design
44
subsection: grammar
55
---
66

7-
**Truncate**, or shorten, your content whenever a string overflows the container and you don't want multiple lines of text. Typically, this is done by utilizing ellipses (...).
7+
**Truncate**, or shorten, your content whenever a string overflows the container and you don't want multiple lines of text. Typically, this is done by utilizing ellipses (...), either manually, or via our [truncate component](/components/truncate).
88

99
For example, use truncation when a URL overflows its container:
1010

0 commit comments

Comments
 (0)