Class NotificationBanner

Notification Banner component

Hierarchy (view full)

GOVUKFrontendComponent
- NotificationBanner

Index

Constructors

Properties

$module config defaults moduleName schema

Methods

checkSupport isSupported

Constructors

constructor

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

Properties

`Private`$module

$module: HTMLElement

`Private`config

config: NotificationBannerConfig

`Static` `Constant`defaults

defaults: NotificationBannerConfig = ...

Notification banner default config

See

NotificationBannerConfig

`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

Methods

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

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