Class Component<RootElementType>`Virtual`

Base Component class

Centralises the behaviours shared by our components

Type Parameters

RootElementType extends Element = HTMLElement

Hierarchy (View Summary)

Component

Index

Constructors

Properties

_$root elementType

Accessors

Methods

checkInitialised checkSupport

Constructors

constructor

new Component<RootElementType extends Element = HTMLElement>(
$root?: Element,
): Component<RootElementType>
Internal
Constructs a new component, validating that GOV.UK Frontend is supported
Type Parameters
- RootElementType extends Element = HTMLElement
Parameters
- Optional$root: Element
  HTML element to use for component
Returns Component<RootElementType>
- Defined in govuk/component.mjs:43

Properties

`Protected`_$root

_$root: RootElementType

`Static`elementType

elementType: new () => Element = HTMLElement

Accessors

`Protected`$root

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

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

Methods

`Private`checkInitialised

checkInitialised(): void
Private
Validates whether component is already initialised

Returns void
Throws
when component is already initialised
- Defined in govuk/component.mjs:85

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

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