ClassSkipLink

Skip link component

Hierarchy (view full)

Component
- SkipLink

Index

Constructors

Properties

_$root _config elementType moduleName

Accessors

Methods

checkSupport configOverride

Constructors

constructor

new SkipLink($root): 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

_config

_config: any

`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 GOVUKFrontendComponent.$root
- Defined in govuk/govuk-frontend-component.mjs:48

`Protected`config

get config(): Config<ConfigType> & ConfigType
Protected
Returns the root element of the component

Returns Config<ConfigType> & ConfigType
- the root element of component
Inherited from GOVUKFrontendComponent.config
- Defined in govuk/govuk-frontend-component.mjs:30

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/govuk-frontend-component.mjs:152

`Static`configOverride

configOverride(config): {
[key: string]: unknown;
}
Override configuration
Parameters
- config: {
  [key: string]: unknown;
  }
  config to override
  - [key: string]: unknown
Returns {
[key: string]: unknown;
}
- overidden config
- [key: string]: unknown
Inherited from Component.configOverride
- Defined in govuk/govuk-frontend-component.mjs:164