Linklist
Stacked list of navigation links with an arrow affordance and a stretched click area. A styled <nav> wrapping <ul> + <li> - not a content grid and not a card type. Used for "related links", "in this section", and "quick links" blocks in sidebars and aside panels, and for link columns in a site footer. Composable size values (sm, md, lg) control density, and the horizontal orientation value swaps the default vertical stack for a row.
Usage
When to use
- "Related links", "in this section", or "quick links" blocks inside a sidebar or aside region
- Link columns in a site footer - the footer reference compositions build their columns from
linklist - Any vertical stack of navigational pointers where the whole row should be clickable
- When the consumer wants a clear list affordance with arrow chevrons rather than plain inline links
When not to use
- For the primary site navigation (header menus, sidebar navigation) - use the
navbarorsidenavcomponent - For horizontal site menus - the
horizontalorientation value lays the links in a row, but primary navigation still belongs tonavbar - For content tiles with images or rich metadata - use a card grid via a
collection
Do
- Wrap the list in
<nav>with a descriptivearia-label - Mark the current page with
aria-current="page" - Keep link text short so each row reads cleanly at a glance
Don't
- Put more than a short sentence of text in a link row
- Mix link rows with non-link content
- Use
linklistfor the primary site navigation
API
Props
| Prop | Type | Default | Description |
|---|---|---|---|
items | array | - | Array of {url, text, is_current?} link objects. Each url is the anchor href, text is the link label, and is_current marks the active page. |
label | string | - | Value for aria-label on the nav wrapper. |
classes | array | - | Additional CSS class words merged into the root element. |
attributes | object | - | Additional HTML attributes spread on the root element. |
Classes
| Class | Capability | Default | Description |
|---|---|---|---|
.subtle | Emphasis | - | Lower emphasis; a muted, quieter weight. |
.neutral | Emphasis | Yes | Default emphasis; the standard weight at balanced contrast. |
.accent | Emphasis | - | Higher emphasis; a stronger, louder weight. |
.sm | Size | - | Small. |
.md | Size | Yes | Medium. |
.lg | Size | - | Large. |
.horizontal | Orientation | - | Children flow along the horizontal axis. |
.vertical | Orientation | Yes | Children flow along the vertical axis. |
.animated | Motion | Yes | Honors the animations option. |
.still | Motion | - | Forces motion off regardless of the option. |
Examples
Default
Medium-size list with multiple links and an active item.
Small
Compact size using the .sm value.
Large
Larger rows and larger font via the .lg value.
Active item
aria-current="page" driving the active state.
Accessibility
- WCAG 2.2 AA
- The list is wrapped in
<nav>with a descriptivearia-label(e.g. "Related", "In this section", "Quick links") whenever used for navigation. - The current item is marked with
aria-current="page"- the active style is driven by the attribute, not by a class. - The arrow icon is decorative and invisible to assistive tech.
:focus-visibleoutline covers the whole row, not just the text.- Whole-row click achieved with a stretched link so the click target matches the visual row
- Any icon motion is disabled under
prefers-reduced-motion.
Related
- link - primitive anchor styling
- navbar, sidenav - site navigation menus (horizontal or vertical)
- footer - composes
linklistfor its link columns - collection - card grids and filterable listings