SkipLink
Enables users to skip directly to primary content in any component.
GuidelinesReact
To implement SkipLink component into your project you’ll need to add the import:
import SkipLink from "@kiwicom/orbit-components/lib/SkipLink";
After adding import into your project you can use it simply like:
<SkipLinklinks={[{href: "#terms",name: "Go to terms and conditions",},{name: "Reguest refund",onClick: handler,},]}/>
Screen reader will read the content in the following order:
- content of the link
- aria-label of nav
- navigation
The table below contains all types of props available in the SkipLink component.
Name | Type | Description |
---|---|---|
buttonLabel | string | Description for screen readers. |
links | links[] | An array specifying links to point to. |
The table below contains all types of props available for links array.
Name | Type | Description |
---|---|---|
name | string | Name of a action. |
link | string | A href for linking to another page. |
onClick | () => void \| Promise | Callback for handling action. |
- SkipLink is visible only on focus.
SkipLink is used to adress WCAG2.0 Criterion 2.4.1. The intent of this is to allow people who navigate sequentially through content more direct access to the primary content and common actions of the Web page which can be hidden inside menus or in otherwise complex content.