Class NotificationBanner

Notification Banner component

Hierarchy (View Summary)

ConfigurableComponent
- NotificationBanner

Index

Constructors

Properties

_$root _config defaults elementType moduleName schema

Accessors

Methods

[configOverride] checkSupport

Constructors

constructor

new NotificationBanner(
$root: Element,
config?: NotificationBannerConfig,
): NotificationBanner
Parameters
- $root: Element
  HTML element to use for notification banner
- Optionalconfig: NotificationBannerConfig = {}
  Notification banner config
Returns NotificationBanner
Overrides ConfigurableComponent.constructor
- Defined in govuk/components/notification-banner/notification-banner.mjs:15

Properties

`Protected`_$root

_$root: HTMLElement

_config

_config: NotificationBannerConfig

`Static` `Constant`defaults

defaults: NotificationBannerConfig = ...

Notification banner default config

See

NotificationBannerConfig

`Static`elementType

elementType: new () => Element = HTMLElement

`Static`moduleName

moduleName: string = 'govuk-notification-banner'

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

`Static` `Constant`schema

schema: Readonly<{ properties: { disableAutoFocus: { type: "boolean" } } }> = ...

Notification banner config schema

Satisfies

Accessors

`Protected`$root

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

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

`Protected`config

get config(): ConfigurationType
Protected
Returns the root element of the component

Returns ConfigurationType
- the root element of component
Inherited from govuk-frontend.config
- Defined in govuk/common/configuration.mjs:46

Methods

[configOverride]

"[configOverride]"(
param?: Partial<NotificationBannerConfig>,
): Partial<NotificationBannerConfig>
Internal Virtual
configOverride

Function which defines configuration overrides to prioritize properties from the root element's dataset.

It should take a subset of configuration as input and return a new configuration object with properties that should be overridden based on the root element's dataset. A Symbol is used for indexing to prevent conflicts.
Parameters
- Optionalparam: Partial<NotificationBannerConfig>
  Configuration object
Returns Partial<NotificationBannerConfig>
return - Configuration object
Inherited from ConfigurableComponent.[configOverride]
- Defined in govuk/common/configuration.mjs:36

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

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