@types/govuk-frontend 5.4.0

govuk-frontend/dist/govuk/components/checkboxes/checkboxes.d.ts

@@ -0,0 +1,27 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Checkboxes component
+ */
+export class Checkboxes extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Checkboxes can be associated with a 'conditionally revealed' content block
+     * – for example, a checkbox for 'Phone' could reveal an additional form field
+     * for the user to enter their phone number.
+     *
+     * These associations are made using a `data-aria-controls` attribute, which
+     * is promoted to an aria-controls attribute during initialisation.
+     *
+     * We also need to restore the state of any conditional reveals on the page
+     * (for example if the user has navigated back), and set up event handlers to
+     * keep the reveal in sync with the checkbox state.
+     *
+     * @param {Element | null} $module - HTML element to use for checkboxes
+     */
+    constructor($module: Element | null);
+}

govuk-frontend/dist/govuk/components/error-summary/error-summary.d.mts

@@ -0,0 +1 @@
+export * from "./error-summary.js";

govuk-frontend/dist/govuk/components/error-summary/error-summary.d.ts

@@ -0,0 +1,51 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Error summary component
+ *
+ * Takes focus on initialisation for accessible announcement, unless disabled in
+ * configuration.
+ */
+export class ErrorSummary extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Error summary default config
+     *
+     * @see {@link ErrorSummaryConfig}
+     */
+    static defaults: ErrorSummaryConfig;
+
+    /**
+     * Error summary config schema
+     *
+     * @satisfies {Schema}
+     */
+    static schema: Readonly<{
+        properties: {
+            disableAutoFocus: {
+                type: "boolean";
+            };
+        };
+    }>;
+
+    /**
+     * @param {Element | null} $module - HTML element to use for error summary
+     * @param {ErrorSummaryConfig} [config] - Error summary config
+     */
+    constructor($module: Element | null, config?: ErrorSummaryConfig);
+}
+
+/**
+ * Error summary config
+ */
+export interface ErrorSummaryConfig {
+    /**
+     * - If set to `true` the error
+     * summary will not be focussed when the page loads.
+     */
+    disableAutoFocus?: boolean;
+}

govuk-frontend/dist/govuk/components/exit-this-page/exit-this-page.d.mts

@@ -0,0 +1 @@
+export * from "./exit-this-page.js";

govuk-frontend/dist/govuk/components/exit-this-page/exit-this-page.d.ts

@@ -0,0 +1,77 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Exit this page component
+ */
+export class ExitThisPage extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Exit this page default config
+     *
+     * @see {@link ExitThisPageConfig}
+     */
+    static defaults: ExitThisPageConfig;
+
+    /**
+     * Exit this page config schema
+     *
+     * @satisfies {Schema}
+     */
+    static schema: Readonly<{
+        properties: {
+            i18n: {
+                type: "object";
+            };
+        };
+    }>;
+
+    /**
+     * @param {Element | null} $module - HTML element that wraps the Exit This Page button
+     * @param {ExitThisPageConfig} [config] - Exit This Page config
+     */
+    constructor($module: Element | null, config?: ExitThisPageConfig);
+}
+
+/**
+ * Exit this Page config
+ */
+export interface ExitThisPageConfig {
+    /**
+     * - Exit this page translations
+     */
+    i18n?: ExitThisPageTranslations | undefined;
+}
+
+/**
+ * Messages used by the component programatically inserted text, including
+ * overlay text and screen reader announcements.
+ */
+export interface ExitThisPageTranslations {
+    /**
+     * - Screen reader announcement for when EtP
+     * keypress functionality has been successfully activated.
+     */
+    activated?: string | undefined;
+
+    /**
+     * - Screen reader announcement for when the EtP
+     * keypress functionality has timed out.
+     */
+    timedOut?: string | undefined;
+
+    /**
+     * - Screen reader announcement informing
+     * the user they must press the activation key two more times.
+     */
+    pressTwoMoreTimes?: string | undefined;
+
+    /**
+     * - Screen reader announcement informing
+     * the user they must press the activation key one more time.
+     */
+    pressOneMoreTime?: string | undefined;
+}

govuk-frontend/dist/govuk/components/header/header.d.mts

@@ -0,0 +1 @@
+export * from "./header.js";

govuk-frontend/dist/govuk/components/header/header.d.ts

@@ -0,0 +1,19 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Header component
+ */
+export class Header extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Apply a matchMedia for desktop which will trigger a state sync if the
+     * browser viewport moves between states.
+     *
+     * @param {Element | null} $module - HTML element to use for header
+     */
+    constructor($module: Element | null);
+}

govuk-frontend/dist/govuk/components/notification-banner/notification-banner.d.mts

@@ -0,0 +1 @@
+export * from "./notification-banner.js";

govuk-frontend/dist/govuk/components/notification-banner/notification-banner.d.ts

@@ -0,0 +1,50 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Notification Banner component
+ */
+export class NotificationBanner extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Notification banner default config
+     *
+     * @see {@link NotificationBannerConfig}
+     */
+    static defaults: NotificationBannerConfig;
+
+    /**
+     * Notification banner config schema
+     *
+     * @satisfies {Schema}
+     */
+    static schema: Readonly<{
+        properties: {
+            disableAutoFocus: {
+                type: "boolean";
+            };
+        };
+    }>;
+
+    /**
+     * @param {Element | null} $module - HTML element to use for notification banner
+     * @param {NotificationBannerConfig} [config] - Notification banner config
+     */
+    constructor($module: Element | null, config?: NotificationBannerConfig);
+}
+
+/**
+ * Notification banner config
+ */
+export interface NotificationBannerConfig {
+    /**
+     * - If set to `true` the
+     * notification banner will not be focussed when the page loads. This only
+     * applies if the component has a `role` of `alert` – in other cases the
+     * component will not be focused on page load, regardless of this option.
+     */
+    disableAutoFocus?: boolean | undefined;
+}

govuk-frontend/dist/govuk/components/password-input/password-input.d.mts

@@ -0,0 +1 @@
+export * from "./password-input.js";

govuk-frontend/dist/govuk/components/password-input/password-input.d.ts

@@ -0,0 +1,90 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Password input component
+ */
+export class PasswordInput extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Password input default config
+     *
+     * @see {@link PasswordInputConfig}
+     */
+    static defaults: PasswordInputConfig;
+
+    /**
+     * Password input config schema
+     *
+     * @satisfies {Schema}
+     */
+    static schema: Readonly<{
+        properties: {
+            i18n: {
+                type: "object";
+            };
+        };
+    }>;
+
+    /**
+     * @param {Element | null} $module - HTML element to use for password input
+     * @param {PasswordInputConfig} [config] - Password input config
+     */
+    constructor($module: Element | null, config?: PasswordInputConfig);
+}
+
+/**
+ * Password input config
+ */
+export interface PasswordInputConfig {
+    /**
+     * - Password input translations
+     */
+    i18n?: PasswordInputTranslations | undefined;
+}
+
+/**
+ * Messages displayed to the user indicating the state of the show/hide toggle.
+ */
+export interface PasswordInputTranslations {
+    /**
+     * - Visible text of the button when the
+     * password is currently hidden. Plain text only.
+     */
+    showPassword?: string | undefined;
+
+    /**
+     * - Visible text of the button when the
+     * password is currently visible. Plain text only.
+     */
+    hidePassword?: string | undefined;
+
+    /**
+     * - aria-label of the button when
+     * the password is currently hidden. Plain text only.
+     */
+    showPasswordAriaLabel?: string | undefined;
+
+    /**
+     * - aria-label of the button when
+     * the password is currently visible. Plain text only.
+     */
+    hidePasswordAriaLabel?: string | undefined;
+
+    /**
+     * - Screen reader
+     * announcement to make when the password has just become visible.
+     * Plain text only.
+     */
+    passwordShownAnnouncement?: string | undefined;
+
+    /**
+     * - Screen reader
+     * announcement to make when the password has just been hidden.
+     * Plain text only.
+     */
+    passwordHiddenAnnouncement?: string | undefined;
+}

govuk-frontend/dist/govuk/components/radios/radios.d.mts

@@ -0,0 +1 @@
+export * from "./radios.js";

govuk-frontend/dist/govuk/components/radios/radios.d.ts

@@ -0,0 +1,27 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Radios component
+ */
+export class Radios extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * Radios can be associated with a 'conditionally revealed' content block –
+     * for example, a radio for 'Phone' could reveal an additional form field for
+     * the user to enter their phone number.
+     *
+     * These associations are made using a `data-aria-controls` attribute, which
+     * is promoted to an aria-controls attribute during initialisation.
+     *
+     * We also need to restore the state of any conditional reveals on the page
+     * (for example if the user has navigated back), and set up event handlers to
+     * keep the reveal in sync with the radio state.
+     *
+     * @param {Element | null} $module - HTML element to use for radios
+     */
+    constructor($module: Element | null);
+}

govuk-frontend/dist/govuk/components/skip-link/skip-link.d.mts

@@ -0,0 +1 @@
+export * from "./skip-link.js";

govuk-frontend/dist/govuk/components/skip-link/skip-link.d.ts

@@ -0,0 +1,19 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Skip link component
+ */
+export class SkipLink extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * @param {Element | null} $module - HTML element to use for skip link
+     * @throws {ElementError} when $module is not set or the wrong type
+     * @throws {ElementError} when $module.hash does not contain a hash
+     * @throws {ElementError} when the linked element is missing or the wrong type
+     */
+    constructor($module: Element | null);
+}

govuk-frontend/dist/govuk/components/tabs/tabs.d.mts

@@ -0,0 +1 @@
+export * from "./tabs.js";

govuk-frontend/dist/govuk/components/tabs/tabs.d.ts

@@ -0,0 +1,16 @@
+import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+
+/**
+ * Tabs component
+ */
+export class Tabs extends GOVUKFrontendComponent {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * @param {Element | null} $module - HTML element to use for tabs
+     */
+    constructor($module: Element | null);
+}

govuk-frontend/dist/govuk/errors/index.d.mts

@@ -0,0 +1 @@
+export * from "./index.js";

govuk-frontend/dist/govuk/errors/index.d.ts

@@ -0,0 +1,83 @@
+/**
+ * GOV.UK Frontend error
+ *
+ * A base class for `Error`s thrown by GOV.UK Frontend.
+ *
+ * It is meant to be extended into specific types of errors
+ * to be thrown by our code.
+ *
+ * @example
+ * ```js
+ * class MissingRootError extends GOVUKFrontendError {
+ *   // Setting an explicit name is important as extending the class will not
+ *   // set a new `name` on the subclass. The `name` property is important
+ *   // to ensure intelligible error names even if the class name gets
+ *   // mangled by a minifier
+ *   name = "MissingRootError"
+ * }
+ * ```
+ */
+export class GOVUKFrontendError extends Error {
+}
+
+/**
+ * Indicates that GOV.UK Frontend is not supported
+ */
+export class SupportError extends GOVUKFrontendError {
+    /**
+     * Checks if GOV.UK Frontend is supported on this page
+     *
+     * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+     */
+    constructor($scope?: HTMLElement | null);
+}
+
+/**
+ * Indicates that a component has received an illegal configuration
+ */
+export class ConfigError extends GOVUKFrontendError {
+}
+
+/**
+ * Indicates an issue with an element (possibly `null` or `undefined`)
+ */
+export class ElementError extends GOVUKFrontendError {
+    /**
+     * @internal
+     * @overload
+     * @param {string} message - Element error message
+     */
+    constructor(message: string);
+
+    /**
+     * @internal
+     * @overload
+     * @param {ElementErrorOptions} options - Element error options
+     */
+    constructor(options: ElementErrorOptions);
+}
+
+/**
+ * Element error options
+ */
+export interface ElementErrorOptions {
+    /**
+     * - The name of the component throwing the error
+     */
+    componentName: string;
+
+    /**
+     * - An identifier that'll let the user understand which element has an error. This is whatever makes the most sense
+     */
+    identifier: string;
+
+    /**
+     * - The element in error
+     */
+    element?: Element | null | undefined;
+
+    /**
+     * - The type that was expected for the identifier
+     */
+    expectedType?: string | undefined;
+}

govuk-frontend/dist/govuk/govuk-frontend-component.d.mts

@@ -0,0 +1 @@
+export * from "./govuk-frontend-component.js";

govuk-frontend/dist/govuk/govuk-frontend-component.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Base Component class
+ *
+ * Centralises the behaviours shared by our components
+ *
+ * @internal
+ */
+export class GOVUKFrontendComponent {
+}

govuk-frontend/dist/govuk/i18n.d.mts

@@ -0,0 +1 @@
+export * from "./i18n.js";