In-page navigation
Link to sections within a long page so people can find information quickly.
Overview
Learn about this guide.
Requirements
Check what you need.
Get started
Follow the steps to get started.
Recommended API
| Property or element | Type | Example initial value | Description |
|---|---|---|---|
href | Hash reference | Per section | Map each link to the corresponding section ID. |
tabindex | Integer | -1 on each destination | Let an anchor move focus to the target section. |
States
| State | Trigger | Result |
|---|---|---|
navigated | Follow a section link. | The browser moves to that section on the same page. |
CSS variables
| Variable | Type | Default | Description |
|---|---|---|---|
--q-text | color | #28302a | Main text and foreground color. |
--q-muted | color | #70776f | Color for secondary text. |
--q-font-size | length | 13px | Base size for the component text. |
--q-accent | color | #344e41 | Accent for active controls, indicators and focus. |
--q-border | color | #dce0d8 | Color for outlines and dividers. |
--q-gap | length | calc(var(--q-space) * 2) | Space between items, based on the spacing unit. |
--q-space | length | 4px | Base unit for gaps and padding. |