amenui
en·中 github ↗ v0.0.1
01docs 02components 03lab 04works
en·中github ↗
×

docs / components / navigation / skip-link docs / components / navigation /

skip-link

04.28
On this page ▾
  1. Installation
  2. Usage
  3. API
  4. Keyboard and accessibility

A link keyboard users meet first that moves focus past the navigation to the main content.

drawn by amenuiopen ↗

Installation

Components are distributed as source. Copy it and what it depends on into your project, then change it as you need:

sh
cargo run --release --bin amenui -- add skip-link --to ../my-app

Files copied: src/widgets/skip_link.rs, src/widgets/mod.rs

Usage

rust
use amenui::widgets::{skip_link};

API

Functionsskip_link
Propskey, label, target (the key of the element to jump to; focus goes to it, or to the
Filessrc/widgets/skip_link.rs
Depends onbase
Response to frontsnudge (a control: pushed as one piece by fronts, held and condensing at most to Look::legible_cap)
Recompositionkeyed labels recompose when their text changes

Keyboard and accessibility

Statesshown only while it has focus.
Keys and messagesnone (the runtime moves focus itself).

On the web every control is mirrored into the page as an element with its role and name, so screen readers and the browser's own focus see it (DESIGN.md §1.14).