Class NotificationBanner

Notification Banner component

Hierarchy (view full)

GOVUKFrontendComponentConfigurable
- NotificationBanner

Index

Constructors

constructor

new NotificationBanner($root, config?): NotificationBanner
Parameters
- $root: Element
  HTML element to use for notification banner
- Optionalconfig: NotificationBannerConfig = {}
  Notification banner config
Returns NotificationBanner
Overrides GOVUKFrontendComponentConfigurable.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 GOVUKFrontendComponentConfigurable.$root
- Defined in govuk/govuk-frontend-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 GOVUKFrontendComponentConfigurable.config
- Defined in govuk/common/configuration.mjs:23

Methods

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

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

Class NotificationBanner

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotificationBanner

Properties

`Protected`_$root

_config

`Static` `Constant`defaults

See

`Static`elementType

`Static`moduleName

`Static` `Constant`schema

Satisfies

Accessors

`Protected`$root

Returns RootElementType

`Protected`config

Returns ConfigurationType

Methods

`Static`checkSupport

Returns void

Throws

Settings

On This Page

Class NotificationBanner

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotificationBanner

Properties

Protected_$root

_config

Static Constantdefaults

See

StaticelementType

StaticmoduleName

Static Constantschema

Satisfies

Accessors

Protected$root

Returns RootElementType

Protectedconfig

Returns ConfigurationType

Methods

StaticcheckSupport

Returns void

Throws

Settings

On This Page

`Protected`_$root

`Static` `Constant`defaults

`Static`elementType

`Static`moduleName

`Static` `Constant`schema

`Protected`$root

`Protected`config

`Static`checkSupport