Back to library

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 elementTypeExample initial valueDescription
hrefHash referencePer sectionMap each link to the corresponding section ID.
tabindexInteger-1 on each destinationLet an anchor move focus to the target section.

States

StateTriggerResult
navigatedFollow a section link.The browser moves to that section on the same page.

CSS variables

VariableTypeDefaultDescription
--q-textcolor #28302aMain text and foreground color.
--q-mutedcolor #70776fColor for secondary text.
--q-font-sizelength 13pxBase size for the component text.
--q-accentcolor #344e41Accent for active controls, indicators and focus.
--q-bordercolor #dce0d8Color for outlines and dividers.
--q-gaplength calc(var(--q-space) * 2)Space between items, based on the spacing unit.
--q-spacelength 4pxBase unit for gaps and padding.