Class GOVUKFrontendComponent`Internal` `Virtual`

Base Component class

Centralises the behaviours shared by our components

Hierarchy (view full)

GOVUKFrontendComponent

Index

Constructors

Methods

checkInitialised checkSupport isSupported

Constructors

constructor

new GOVUKFrontendComponent($module?): GOVUKFrontendComponent
Internal
Constructs a new component, validating that GOV.UK Frontend is supported
Parameters
- Optional$module: Element
  HTML element to use for component
Returns GOVUKFrontendComponent
- Defined in govuk/govuk-frontend-component.mjs:19

Methods

`Private`checkInitialised

checkInitialised($module?): void
Private
Validates whether component is already initialised
Parameters
- Optional$module: Element
  HTML element to be checked
Returns void
Throws
when component is already initialised
- Defined in govuk/govuk-frontend-component.mjs:44

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

Returns void
Throws
when the components are not supported
- 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
- Defined in govuk/govuk-frontend-component.mjs:70