Skip to content

Commit f0150dc

Browse files
docs(jump links): Updates images for v6. (#4614)
* docs(jump links): Updates images for v6. * Updating annotation and associated content (Elements section). --------- Co-authored-by: Andrew Ronaldson <aronalds@redhat.com>
1 parent 0774ef2 commit f0150dc

8 files changed

Lines changed: 1053 additions & 10 deletions

File tree

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

Lines changed: 38 additions & 0 deletions
Loading

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

Lines changed: 139 additions & 0 deletions
Loading

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

Lines changed: 233 additions & 0 deletions
Loading

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

Lines changed: 163 additions & 0 deletions
Loading

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

Lines changed: 163 additions & 0 deletions
Loading

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

Lines changed: 150 additions & 0 deletions
Loading

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

Lines changed: 140 additions & 0 deletions
Loading

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

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,63 @@ id: Jump links
33
section: components
44
---
55

6+
import '../components.css';
7+
68
## Elements
79

8-
<img src="./img/jump-elements.png" alt="Elements of a jump link" width="249"/>
10+
<div class="ws-docs-content-img">
11+
![Elements of a jump link.](./img/jump-links-elements.svg)
12+
</div>
13+
14+
1. **Label (optional):** A descriptive header for a list of jump links.
915

10-
1. **Active section:** current section of the page the user is on.
16+
2. **Active section:** current section of the page the user is on.
1117

12-
2. **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:** 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.
1319

1420
## Usage
1521
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.
1622

1723
### Placement
1824
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.
1925

20-
<img src="./img/Jumplink-left.png" alt="Example of jump links with subsections" width="800"/>
21-
<img src="./img/Jumplink-right.png" alt="Example of jump links with subsections" width="800"/>
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>
2232

2333
### Jump links on mobile
2434
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.
2535

26-
<img src="./img/jump-mobile.png" alt="Example jump link in a mobile format" width="800"/>
36+
<div class="ws-docs-content-img">
37+
![Example of expandable jump links on mobile.](./img/jump-links-mobile.svg)
38+
</div>
2739

2840
## Variations
2941
Jump links can be displayed either horizontally or vertically. They can include optional subsections.
3042

3143
### Vertical jump links
3244
As the user scrolls down the page, the active sections are highlighted from top to bottom. This is the recommended variation.
3345

34-
<img src="./img/jump-vertical.png" alt="Example of vertical jump link" width="800"/>
46+
<div class="ws-docs-content-img">
47+
![Example of vertical jump links.](./img/jump-links-vertical.svg)
48+
</div>
3549

3650
### Horizontal jump links
3751
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.
3852

39-
<img src="./img/jump-horizontal.png" alt="Example of horizontal jump link" width="800"/>
40-
53+
<div class="ws-docs-content-img">
54+
![Example of horizontal jump links.](./img/jump-links-horizontal.svg)
55+
</div>
4156

4257
### Jump links with subsections
4358
If the page has subsections, they are shown as indented jump links under the parent section. Subsections can be individually selected.
4459

45-
<img src="./img/jump-subsection.png" alt="Example of jump links with subsections" width="800"/>
60+
<div class="ws-docs-content-img">
61+
![Example of jump links with subsections.](./img/jump-links-subsections.svg)
62+
</div>
4663

4764
## Accessibility
4865
For information regarding accessibility, visit the [jump links accessibility](/components/jump-links/accessibility) tab.

0 commit comments

Comments
 (0)