Class SkipLink

Skip link component

Hierarchy (view full)

GOVUKFrontendComponent
- SkipLink

Index

Constructors

Properties

$module moduleName

Methods

checkSupport isSupported

Constructors

constructor

new SkipLink($module): SkipLink
Parameters
- $module: Element
  HTML element to use for skip link
Returns SkipLink
Throws
when $module is not set or the wrong type

Throws
when $module.hash does not contain a hash

Throws
when the linked element is missing or the wrong type
Overrides GOVUKFrontendComponent.constructor
- Defined in govuk/components/skip-link/skip-link.mjs:20

Properties

`Private`$module

$module: HTMLAnchorElement

`Static`moduleName

moduleName: string = 'govuk-skip-link'

Name for the component used when initialising using data-module attributes.

Methods

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

Returns void
Throws
when the components are not supported
Inherited from GOVUKFrontendComponent.checkSupport
- Defined in govuk/govuk-frontend-component.mjs:58

`Protected` `Static`isSupported

isSupported(): boolean
Protected
Defines whether the components are supported

Returns boolean
whether the components are supported
Inherited from GOVUKFrontendComponent.isSupported
- Defined in govuk/govuk-frontend-component.mjs:70