diff --git a/packages/docs/page-config/navigationRoutes.ts b/packages/docs/page-config/navigationRoutes.ts index 5c0d2f9dad..792cceb004 100644 --- a/packages/docs/page-config/navigationRoutes.ts +++ b/packages/docs/page-config/navigationRoutes.ts @@ -342,6 +342,13 @@ export const navigationRoutes: NavigationRoute[] = [ name: "sidebar-item", displayName: "Sidebar Item", }, + { + name: "skip-link", + displayName: "Skip Link", + meta: { + badge: navigationBadge.new('1.7.6'), + } + }, { name: 'stepper', displayName: 'Stepper', diff --git a/packages/docs/page-config/ui-elements/skip-link/api-description.ts b/packages/docs/page-config/ui-elements/skip-link/api-description.ts new file mode 100644 index 0000000000..2e95f0ac75 --- /dev/null +++ b/packages/docs/page-config/ui-elements/skip-link/api-description.ts @@ -0,0 +1,11 @@ +import { defineApiDescription } from "~/modules/page-config/runtime"; + +export default defineApiDescription({ + props: { + target: "Selector to the target component.", + position: "Position on the page.", + }, + slots: { + default: "Skip link content slot.", + } +}); diff --git a/packages/docs/page-config/ui-elements/skip-link/api-options.ts b/packages/docs/page-config/ui-elements/skip-link/api-options.ts new file mode 100644 index 0000000000..c13af8ebf2 --- /dev/null +++ b/packages/docs/page-config/ui-elements/skip-link/api-options.ts @@ -0,0 +1,5 @@ +export default defineManualApi({ + slots: { + default: {}, + }, +}); diff --git a/packages/docs/page-config/ui-elements/skip-link/index.ts b/packages/docs/page-config/ui-elements/skip-link/index.ts new file mode 100644 index 0000000000..5bee984785 --- /dev/null +++ b/packages/docs/page-config/ui-elements/skip-link/index.ts @@ -0,0 +1,20 @@ +import apiOptions from "./api-options"; +import apiDescription from './api-description'; + +export default definePageConfig({ + blocks: [ + block.title("Skip Link"), + block.paragraph("`va-skip-link` skip to the target component."), + + block.subtitle("Basic usage"), + + block.paragraph("By default, `va-skip-link` needs a target and position, please keep in mind that the component should be placed as the very first element."), + + block.subtitle("Example"), + + block.paragraph("To test this component - click `Esc`, then press `Tab` and you should be able to see a button that would get you straight to content on `Enter`."), + + block.subtitle("API"), + block.api("VaSkipLink", apiDescription, apiOptions), + ], +}); diff --git a/packages/docs/pages/[page-config-category]/[page].vue b/packages/docs/pages/[page-config-category]/[page].vue index a7dd4e922a..b3c515f0f2 100644 --- a/packages/docs/pages/[page-config-category]/[page].vue +++ b/packages/docs/pages/[page-config-category]/[page].vue @@ -1,5 +1,13 @@