Class Button

JavaScript enhancements for the Button component

Hierarchy (view full)

GOVUKFrontendComponent
- Button

Index

Constructors

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
- Optionalconfig: ButtonConfig = {}
  Button config
Returns Button
Overrides GOVUKFrontendComponent.constructor
- Defined in govuk/components/button/button.mjs:33

Properties

`Private`$module

$module: HTMLElement

`Private`config

config: ButtonConfig

`Private`debounceFormSubmitTimer

debounceFormSubmitTimer: number = null

`Static` `Constant`defaults

defaults: ButtonConfig = ...

Button default config

See

`Static`moduleName

moduleName: string = 'govuk-button'

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

`Static` `Constant`schema

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

Button config schema

Satisfies

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
- Defined in govuk/components/button/button.mjs:99

`Private`handleKeyDown

handleKeyDown(event): void
Private
Trigger a click event when the space key is pressed

Some screen readers tell users they can use the space bar to activate things with the 'button' role, so we need to match the functionality of native HTML buttons.

See https://github.com/alphagov/govuk_elements/pull/272#issuecomment-233028270
Parameters
- event: KeyboardEvent
  Keydown event
Returns void
- Defined in govuk/components/button/button.mjs:70