Class ConfigurableComponent<ConfigurationType, RootElementType>Virtual

constructor

• new ConfigurableComponent<
      ConfigurationType extends
          Partial<Record<keyof ConfigurationType, unknown>> = ObjectNested,
      RootElementType extends Element & { dataset: DOMStringMap } = HTMLElement,
  >(
      $root?: Element,
      config?: ConfigurationType,
  ): ConfigurableComponent<ConfigurationType, RootElementType>
  Internal

  Constructs a new component, validating that GOV.UK Frontend is supported

  Type Parameters

  • ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>> = ObjectNested
  • RootElementType extends Element & { dataset: DOMStringMap } = HTMLElement

  Parameters

  • Optional$root: Element

    HTML element to use for component
  • Optionalconfig: ConfigurationType

    HTML element to use for component

  Returns ConfigurableComponent<ConfigurationType, RootElementType>

_config

[configOverride]

• "[configOverride]"(
      param?: Partial<ConfigurationType>,
  ): Partial<ConfigurationType>
  Internal Virtual

  configOverride

  Function which defines configuration overrides to prioritize properties from the root element's dataset.

  It should take a subset of configuration as input and return a new configuration object with properties that should be overridden based on the root element's dataset. A Symbol is used for indexing to prevent conflicts.

  Parameters

  • Optionalparam: Partial<ConfigurationType>

    Configuration object

  Returns Partial<ConfigurationType>

  return - Configuration object