@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
34 lines (15 loc) • 1.27 kB
Markdown
# kol-skip-nav
<!-- Auto Generated Below -->
## Overview
The **SkipNav** component renders a hidden navigation that allows keyboard and assistive technology users to skip repetitive navigation sections and jump directly to the main content. It only becomes visible when reached via the Tab key.
## Properties
| Property | Attribute | Description | Type | Default |
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------- | ----------- |
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
| `_links` _(required)_ | `_links` | Defines the list of links combined with their labels to render. | `LinkProps[] \| string` | `undefined` |
## Methods
### `focus() => Promise<void>`
Sets focus on the internal element.
#### Returns
Type: `Promise<void>`
----------------------------------------------