SkipNavigationButton

An off-screen button that lets keyboard users jump past the menu to the page content.

Installation

pnpm dlx shadcn@latest add @chelone/skip-navigation-button

An off-screen button that lets keyboard users jump past the menu to the page content.

Props

PropTypeDefaultDescription
asChildboolean—
labelstring—An i18n key (contains a dot) or literal text. Default `ra.navigation.skip_nav`.
refRef<HTMLButtonElement>—
size"default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | null—
variant"link" | "default" | "destructive" | "outline" | "secondary" | "ghost" | null—