Class SkipLink

Skip link component

Hierarchy (View Summary)

Component
- SkipLink

Index

Constructors

Properties

_$root elementType moduleName

Accessors

Methods

Constructors

constructor

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

Throws
when $root.hash does not contain a hash

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

Properties

`Protected`_$root

_$root: HTMLAnchorElement

`Static`elementType

elementType: new () => HTMLAnchorElement = HTMLAnchorElement

`Static`moduleName

moduleName: string = 'govuk-skip-link'

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

Accessors

`Protected`$root

get $root(): RootElementType
Protected
Returns the root element of the component

Returns RootElementType
- the root element of component
Inherited from Component.$root
- Defined in govuk/component.mjs:27

Methods

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

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