Class Button

JavaScript enhancements for the Button component

Preserve

Hierarchy

  • GOVUKFrontendComponent
    • Button

Constructors

constructor

Properties

$module config debounceFormSubmitTimer defaults moduleName schema

Methods

debounce handleKeyDown

Constructors

constructor

  • new Button($module, config?): Button

  • Parameters

    • $module: Element

      HTML element to use for button

    • Optional config: ButtonConfig = {}

      Button config

    Returns Button

Properties

Private $module

$module: HTMLElement

Private config

config: ButtonConfig

Private debounceFormSubmitTimer

debounceFormSubmitTimer: number = null

Static defaults

defaults: ButtonConfig = ...

Button default config

See

ButtonConfig

Constant

Static moduleName

moduleName: string = 'govuk-button'

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

Static schema

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

Button config schema

Type declaration

  • properties: {
        preventDoubleClick: {
            type: "boolean";
        };
    }
    • preventDoubleClick: {
          type: "boolean";
      }
      • type: "boolean"

Constant

Methods

Private debounce

  • 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

Private handleKeyDown

Settings

Member Visibility

Theme

On This Page

constructor$moduleconfigdebounceFormSubmitTimerdefaultsmoduleNameschemadebouncehandleKeyDown