Class Details

Details component

Hierarchy (view full)

GOVUKFrontendComponent
- Details

Index

Constructors

Properties

$content $module $summary moduleName

Methods

generateUniqueID polyfillHandleInputs polyfillSetAttributes

Constructors

constructor

new Details($module): Details
Details component constructor
Parameters
- $module: Element
  HTML element to use for details
Returns Details
Overrides GOVUKFrontendComponent.constructor
- Defined in govuk/components/details/details.mjs:20

Properties

$content

$content: HTMLDivElement

$module

$module: HTMLElement

$summary

$summary: HTMLElement

`Static`moduleName

moduleName: string = 'govuk-details'

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

Methods

`Private`generateUniqueID

generateUniqueID(): string
Private
Used to generate a unique string, allows multiple instances of the component without them conflicting with each other. https://stackoverflow.com/a/8809472

Returns string
Unique ID
- Defined in govuk/components/details/details.mjs:153

`Private`polyfillHandleInputs

polyfillHandleInputs(callback): void
Private
Handle cross-modal click events
Parameters
- callback: ((event: UIEvent) => void)
  function
  - - (event): void
    - Parameters
      event: UIEvent
      Returns void
Returns void
- Defined in govuk/components/details/details.mjs:102

`Private`polyfillSetAttributes

polyfillSetAttributes(): boolean
Private
Define a statechange function that updates aria-expanded and style.display

Returns boolean
Returns true
- Defined in govuk/components/details/details.mjs:79