Class ExitThisPage

Private $button

Private $indicatorContainer

Private $module

Private $overlay

Private $skiplinkButton

Private $updateSpan

Private config

Private i18n

Private keypressCounter

Private keypressTimeoutId

Private lastKeyWasModified

Private timeoutMessageId

Private timeoutTime

Private buildIndicator

• buildIndicator(): void
• Private

  Create the HTML for the 'three lights' indicator on the button.

  Returns void

Private exitPage

• exitPage(): void
• Private

  Initiates the redirection away from the current page. Includes the loading overlay functionality, which covers the current page with a white overlay so that the contents are not visible during the loading process. This is particularly important on slow network connections.

  Returns void

Private handleClick

• handleClick(event): void
• Private

  Pre-activation logic for when the button is clicked/activated via mouse or pointer.

  We do this to differentiate it from the keyboard activation event because we need to run e.preventDefault as the button or skiplink are both links and we want to apply some additional logic in exitPage before navigating.

  Parameters

  • event: MouseEvent

    mouse click event

  Returns void

Private handleKeypress

• handleKeypress(event): void
• Private

  Logic for the 'quick escape' keyboard sequence functionality (pressing the Shift key three times without interruption, within a time limit).

  Parameters

  • event: KeyboardEvent

    keyup event

  Returns void

Private initButtonClickHandler

• initButtonClickHandler(): void
• Private

  Create button click handlers.

  Returns void

Private initUpdateSpan

• initUpdateSpan(): void
• Private

  Create the we use for screen reader announcements.

  Returns void

Private resetKeypressTimer

• resetKeypressTimer(): void
• Private

  Stops and resets the 'quick escape' keyboard sequence timer.

  Returns void

Private resetPage

• resetPage(): void
• Private

  Reset the page using the EtP button

  We use this in situations where a user may re-enter a page using the browser back button. In these cases, the browser can choose to restore the state of the page as it was previously, including restoring the 'ghost page' overlay, the announcement span having it's role set to "alert" and the keypress indicator still active, leaving the page in an unusable state.

  By running this check when the page is shown, we can programatically restore the page and the component to a "default" state

  Returns void

Private setKeypressTimer

• setKeypressTimer(): void
• Private

  Starts the 'quick escape' keyboard sequence timer.

  This can be invoked several times. We want this to be possible so that the timer is restarted each time the shortcut key is pressed (e.g. the user has up to n seconds between each keypress, rather than n seconds to invoke the entire sequence.)

  Returns void

Private updateIndicator

• updateIndicator(): void
• Private

  Update whether the lights are visible and which ones are lit up depending on the value of keypressCounter.

  Returns void