ClassButton

JavaScript enhancements for the Button component

Hierarchy (view full)

Constructors

constructor

Properties

_$root _config debounceFormSubmitTimer defaults elementType moduleName schema

Accessors

$root config

Methods

debounce handleKeyDown checkSupport configOverride

Constructors

constructor

Properties

Protected_$root

_$root: HTMLElement

_config

_config: Config<ButtonConfig> & ButtonConfig

PrivatedebounceFormSubmitTimer

debounceFormSubmitTimer: number = null

Static Constantdefaults

defaults: ButtonConfig = ...

Button default config

See

ButtonConfig

StaticelementType

elementType: (new () => Element) = HTMLElement

StaticmoduleName

moduleName: string = 'govuk-button'

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

Static Constantschema

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

Button config schema

Satisfies

Accessors

Protected$root

Protectedconfig

Methods

Privatedebounce

  • debounce(event): false
  • Private

    Debounce double-clicks

    If the click quickly succeeds a previous click then nothing will happen. This stops people accidentally causing multiple form submissions by double clicking buttons.

    Parameters

    • event: MouseEvent

      Mouse click event

    Returns false

    Returns undefined, or false when debounced

PrivatehandleKeyDown

StaticcheckSupport

StaticconfigOverride

  • configOverride(config): {
        [key: string]: unknown;
    }

  • Override configuration

    Parameters

    • config: {
          [key: string]: unknown;
      }

      config to override

      • [key: string]: unknown

    Returns {
        [key: string]: unknown;
    }

    • overidden config
    • [key: string]: unknown

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods