Skip to content

Commit 00f1279

Browse files
docs(jump-links): Updates design guidelines for v6. (#4634)
Co-authored-by: Andrew Ronaldson <aronalds@redhat.com>
1 parent 893e635 commit 00f1279

9 files changed

Lines changed: 61 additions & 15 deletions

File tree

packages/documentation-site/patternfly-docs/content/design-guidelines/components/jump-link/img/jump-links-expandable.svg

Lines changed: 36 additions & 0 deletions
Loading

packages/documentation-site/patternfly-docs/content/design-guidelines/components/jump-link/jump-link.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,15 @@ import '../components.css';
1313

1414
1. **Label (optional):** A descriptive header for a list of jump links.
1515

16-
2. **Active section:** current section of the page the user is on.
16+
2. **Active section:** The current section of the page the user is on.
1717

18-
3. **Inactive section:** other sections of the page that the user is not currently on. Clicking on an inactive section will bring the user to the selected section and make the section active.
18+
3. **Inactive section:** The other sections of the page that the user is not currently on. Clicking on an inactive section will bring the user to the selected section and make the section active.
1919

2020
## Usage
2121
Jump links provide a way to navigate through section headings on a page without scrolling. The highlighted active section changes as the user scrolls to the next section.
2222

23-
### Placement
24-
Vertical jump links can be placed either to the left or the right of the content on the page. It is recommended to place the jump links on the left side of the content and remain consistent with the application you are working on. Only use jump links on the right when space allows and when there is an extensive nav on the left; otherwise, consider reverting to the left of the page. In both placements, the visual system is identical, including jump links with subsections. So use either according to your application’s needs.
25-
26-
<div class="ws-docs-content-img">
27-
![Example of jump links placed on the left of the page.](./img/jump-links-placement-left.svg)
28-
</div>
29-
<div class="ws-docs-content-img">
30-
![Example of jump links placed on the right of the page.](./img/jump-links-placement-right.svg)
31-
</div>
32-
3323
### Jump links on mobile
34-
On smaller screen sizes, jump links collapse into an expandable component that is shown above the content. This component can be expanded to display the jump links.
24+
On smaller screen sizes, use [expandable jump links](#expandable-jump-links). This collapses a list of jump links into one component, which can be expanded to display the list of jump links.
3525

3626
<div class="ws-docs-content-img">
3727
![Example of expandable jump links on mobile.](./img/jump-links-mobile.svg)
@@ -48,7 +38,7 @@ As the user scrolls down the page, the active sections are highlighted from top
4838
</div>
4939

5040
### Horizontal jump links
51-
As the user scrolls down the page, the active sections are highlighted from left to right. A jump link can be displayed left aligned or center aligned and with an optional label.
41+
As the user scrolls down the page, the active sections are highlighted from left to right. A jump link can be displayed left-aligned or center-aligned, and can display an optional label.
5242

5343
<div class="ws-docs-content-img">
5444
![Example of horizontal jump links.](./img/jump-links-horizontal.svg)
@@ -61,5 +51,25 @@ If the page has subsections, they are shown as indented jump links under the par
6151
![Example of jump links with subsections.](./img/jump-links-subsections.svg)
6252
</div>
6353

54+
### Expandable jump links
55+
Expandable jump links hide the list of links within a collapsed section by default. Once users expand the section, they will see the full list of links, which they can then interact with.
56+
57+
<div class="ws-docs-content-img">
58+
![A collapsed section with a "jump to section" link, followed by the expanded version of the section, with sub-items nested in the section.](./img/jump-links-expandable.svg)
59+
</div>
60+
61+
## Placement
62+
Vertical jump links can be placed either to the left or the right of the content on the page. In both placements, the visual system is identical, including jump links with subsections.
63+
64+
We recommended placing jump links on the left side of the content and remaining consistent with the application you are working on. Only use jump links on the right when space allows and when there is an extensive nav on the left; otherwise, consider reverting to the left of the page.
65+
66+
<div class="ws-docs-content-img">
67+
![Example of jump links placed on the left of the page.](./img/jump-links-placement-left.svg)
68+
</div>
69+
70+
<div class="ws-docs-content-img">
71+
![Example of jump links placed on the right of the page.](./img/jump-links-placement-right.svg)
72+
</div>
73+
6474
## Accessibility
65-
For information regarding accessibility, visit the [jump links accessibility](/components/jump-links/accessibility) tab.
75+
For information regarding accessibility, visit the [jump links accessibility](/components/jump-links/accessibility) tab.

0 commit comments

Comments
 (0)