@hmlr/govuk-react-components-library 1.0.3 → 1.2.0

package/dist/types/components/Footer/Footer.types.d.ts

@@ -25,9 +25,16 @@ export interface Meta {
     items?: MetaItem[];
     children?: React.ReactNode;
 }
+export interface ContentLicence {
+    className?: string;
+    children: React.ReactNode;
+    reactListKey?: string | number;
+    [key: string]: unknown;
+}
 export interface FooterProps extends HTMLAttributes<HTMLElement> {
     className?: string;
     containerClassName?: string;
     meta?: Meta;
     navigation?: NavigationItem[];
+    contentLicence?: ContentLicence;
 }

package/dist/types/components/PDFViewerCanvas/PDFViewerCanvas.types.d.ts

@@ -4,5 +4,35 @@ export interface PDFViewerCanvasProps {
     documentName?: string;
     pageNumber?: number;
     showNavigation?: boolean;
+    /**
+     * Background colour of the navigation buttons in their resting state.
+     * Passed directly to DifferenceNavigation.
+     * Defaults to govuk-functional-colour("brand") (#1d70b8).
+     */
+    buttonColour?: string;
+    /**
+     * Text colour of the navigation buttons in their resting state.
+     * Passed directly to DifferenceNavigation.
+     * Defaults to govuk-colour("white") (#ffffff).
+     */
+    buttonTextColour?: string;
+    /**
+     * Shadow colour of the navigation buttons.
+     * Passed directly to DifferenceNavigation.
+     * Defaults to govuk-colour("black") (#0b0c0c).
+     */
+    buttonShadowColour?: string;
+    /**
+     * Background colour of the navigation buttons on hover.
+     * Passed directly to DifferenceNavigation.
+     * Defaults to govuk-functional-colour("focus") (#ffdd00).
+     */
+    buttonHoverColour?: string;
+    /**
+     * Text colour of the navigation buttons on hover.
+     * Passed directly to DifferenceNavigation.
+     * Defaults to govuk-functional-colour("focus-text") (#0b0c0c).
+     */
+    buttonHoverTextColour?: string;
     [key: string]: unknown;
 }

package/dist/types/components/Pagination/Pagination.types.d.ts

@@ -1,22 +1,32 @@
+export interface PaginationItemProps {
+    /** Page number or label (e.g. 1, "one"). Omit when ellipsis is true. */
+    number?: number | string;
+    href?: string;
+    current?: boolean;
+    ellipsis?: boolean;
+}
+export interface PaginationNavProps {
+    href: string;
+    /** Override the default "Previous" / "Next" link text.
+     *  Populated automatically from fixture `text` by ProcessExampleData (text → children). */
+    children?: React.ReactNode;
+    /** Secondary label rendered below the link title (block-layout mode). */
+    labelText?: string;
+}
 export interface PaginationProps {
-    onPageChange: (page: number) => void;
-    totalCount: number;
-    siblingCount?: number;
-    currentPage: number;
-    pageSize: number;
+    previous?: PaginationNavProps;
+    next?: PaginationNavProps;
+    items?: PaginationItemProps[];
     className?: string;
-    previousName?: string;
-    previousChildren?: React.ReactNode;
-    nextName?: string;
-    nextChildren?: React.ReactNode;
 }
 export interface SvgIconProps {
     type: string;
 }
 export interface NavigationButtonProps {
-    isDisabled: boolean;
-    onClick: () => void;
-    children?: React.ReactNode;
-    name: string;
+    href: string;
     type: "next" | "previous";
+    /** Overrides the default "Previous" / "Next" label (from fixture `text` → `children`). */
+    children?: React.ReactNode;
+    /** Optional secondary label shown beneath the link title. */
+    labelText?: string;
 }

package/dist/types/components/Pagination/index.d.ts

@@ -1 +1,3 @@
 export { default as Pagination } from "./Pagination";
+export { UsePagination, DOTS } from "./UsePagination";
+export type { PaginationProps, PaginationNavProps, PaginationItemProps, } from "./Pagination.types";

package/dist/types/components/PasswordInput/PasswordInput.config.d.ts

@@ -0,0 +1 @@
+export declare function ConfigureOverallPasswordInput($scope?: Document | Element): void;

package/dist/types/components/PasswordInput/PasswordInput.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { PasswordInputProps } from "./PasswordInput.types";
+declare const PasswordInput: React.FC<PasswordInputProps & React.InputHTMLAttributes<HTMLInputElement>>;
+export default PasswordInput;

package/dist/types/components/PasswordInput/PasswordInput.types.d.ts

@@ -0,0 +1,49 @@
+export interface PasswordInputLabelProps {
+    children?: React.ReactNode;
+    className?: string;
+    isPageHeading?: boolean;
+    [key: string]: unknown;
+}
+export interface PasswordInputProps {
+    /** Additional CSS classes for the `<input>` element. Maps from fixture `classes` → className */
+    className?: string;
+    /** Pre-existing aria-describedby value to prepend */
+    "aria-describedby"?: string;
+    /** Error message sub-object — `{ children }` after processExampleData transforms `text` */
+    errorMessage?: {
+        children?: React.ReactNode;
+        [key: string]: unknown;
+    };
+    /** Wrapper div options */
+    formGroup?: {
+        className?: string;
+        [key: string]: unknown;
+    };
+    /** Hint sub-object — `{ children }` after processExampleData transforms `text` */
+    hint?: {
+        children?: React.ReactNode;
+        [key: string]: unknown;
+    };
+    /** Label sub-object — `{ children, className, isPageHeading }` */
+    label?: PasswordInputLabelProps;
+    /** Input name attribute */
+    name?: string;
+    /** Input id attribute — also used to link label and aria-describedby */
+    id?: string;
+    /** autocomplete attribute — defaults to "current-password" */
+    autoComplete?: string;
+    /** i18n: label for the show-password button (default: "Show") */
+    showPasswordText?: string;
+    /** i18n: label for the hide-password button (default: "Hide") */
+    hidePasswordText?: string;
+    /** i18n: aria-label for the show-password button */
+    showPasswordAriaLabelText?: string;
+    /** i18n: aria-label for the hide-password button */
+    hidePasswordAriaLabelText?: string;
+    /** i18n: text announced when the password becomes visible */
+    passwordShownAnnouncementText?: string;
+    /** i18n: text announced when the password is hidden */
+    passwordHiddenAnnouncementText?: string;
+    /** Allow pass-through of any other HTML input attributes */
+    [key: string]: unknown;
+}

package/dist/types/components/PasswordInput/index.d.ts

@@ -0,0 +1,2 @@
+export { default as PasswordInput } from "./PasswordInput";
+export * from "./PasswordInput.config";

package/dist/types/components/index.d.ts

@@ -16,6 +16,7 @@ export * from "./DifferenceNavigation";
 export * from "./ErrorBoundary";
 export * from "./ErrorMessage";
 export * from "./ErrorSummary";
+export * from "./ExitThisPage";
 export * from "./Fieldset";
 export * from "./FileUpload";
 export * from "./Footer";
@@ -32,6 +33,7 @@ export * from "./NotFoundPage";
 export * from "./NotificationBanner";
 export * from "./Pagination";
 export * from "./Panel";
+export * from "./PasswordInput";
 export * from "./PDFViewer";
 export * from "./PhaseBanner";
 export * from "./ProblemWithService";

package/dist/types/dynamics/types.d.ts

@@ -1,4 +1,4 @@
-import type { ArgTypes, Tag } from "@storybook/csf";
+import { ArgTypes, Tag } from "storybook/internal/csf";
 type AnyJson = boolean | number | string | null | Array<AnyJson> | JsonMap | React.ReactNode | undefined;
 interface JsonMap {
     [key: string]: AnyJson;

package/dist/types/utils/WithReference.types.d.ts

@@ -1,10 +1,15 @@
 import React from "react";
+type RefAcceptingComponent = React.ComponentType<Record<string, unknown> & {
+    ref?: React.Ref<HTMLElement>;
+}>;
 export interface WithRefProps {
-    Component: React.ComponentType<unknown>;
+    Component: RefAcceptingComponent;
+    items?: unknown[];
     [key: string]: unknown;
 }
 export interface InfoSectionProps {
     refName: string;
-    Component: React.ComponentType<unknown>;
+    Component: RefAcceptingComponent;
     restProps: Record<string, unknown>;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmlr/govuk-react-components-library",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "description": "These are common component use for React applications based on GDS and govuk-frontend",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -24,13 +24,17 @@
     "storybook": "storybook dev -p 6006 --debug-webpack",
     "build-storybook": "storybook build --debug-webpack",
     "test-storybook": "test-storybook",
-    "lint": "eslint 'src/**/*.ts*' && stylelint 'src/**/*.{css,scss,less}'",
-    "lint-fix": "eslint --fix 'src/**/*.ts*' && stylelint --fix 'src/**/*.{css,scss,less}' ",
+    "format:check": "prettier --ignore-path .gitignore --check '**/*.+(js|mjs|ts|tsx|json|css|scss|html|md)'",
+    "lint": "eslint 'src/**/*.ts*' && npm run format:check && stylelint 'src/**/*.{css,scss,less}'",
     "format": "prettier --ignore-path .gitignore --write '**/*.+(js|mjs|ts|tsx|json|css|scss|html|md)'",
+    "lint-fix": "eslint --fix 'src/**/*.ts*' && npm run format && stylelint --fix 'src/**/*.{css,scss,less}' ",
     "prepare": "husky",
     "release": "standard-version",
     "uml": "tsuml2 --glob './src/**/\\!(*.spec|*.test|TestUtilities|JestSetup).[t]s?(x)' -o './assets/uml-diagram.svg'",
-    "chromatic": "npx chromatic --exit-zero-on-changes"
+    "chromatic": "npx chromatic --exit-zero-on-changes",
+    "generate-stories": "node scripts/generateStories.mjs",
+    "prestorybook": "npm run generate-stories",
+    "prebuild-storybook": "npm run generate-stories"
   },
   "repository": {
     "type": "git",
@@ -51,89 +55,87 @@
   "author": "Cyril Adelekan",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "^7.28.4",
-    "@babel/preset-env": "^7.28.3",
-    "@babel/preset-react": "^7.27.1",
-    "@babel/preset-typescript": "^7.27.1",
-    "@chromatic-com/storybook": "^4.1.1",
-    "@commitlint/cli": "^20.1.0",
-    "@commitlint/config-conventional": "^20.0.0",
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.2",
+    "@babel/preset-react": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@chromatic-com/storybook": "^5.0.2",
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
     "@eslint/js": "^9.37.0",
-    "@jest/globals": "^30.2.0",
-    "@rollup/plugin-commonjs": "^28.0.6",
+    "@jest/globals": "^30.3.0",
+    "@rollup/plugin-commonjs": "^29.0.2",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.2",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.4",
-    "@storybook/addon-a11y": "^9.1.10",
-    "@storybook/addon-links": "^9.1.10",
-    "@storybook/addon-styling-webpack": "^2.0.0",
-    "@storybook/addon-webpack5-compiler-swc": "^4.0.1",
-    "@storybook/react-vite": "^9.1.10",
-    "@storybook/react-webpack5": "^9.1.10",
-    "@storybook/test-runner": "^0.23.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@storybook/addon-a11y": "^10.3.0",
+    "@storybook/addon-links": "^10.3.0",
+    "@storybook/addon-styling-webpack": "^3.0.0",
+    "@storybook/addon-webpack5-compiler-swc": "^4.0.2",
+    "@storybook/react-vite": "^10.3.0",
+    "@storybook/react-webpack5": "^10.3.0",
+    "@storybook/test-runner": "^0.24.3",
     "@testing-library/jest-dom": "^6.9.1",
-    "@testing-library/react": "^16.3.0",
+    "@testing-library/react": "^16.3.2",
     "@types/govuk-frontend": "^5.11.0",
     "@types/jest": "^30.0.0",
-    "@types/react": "^19.2.2",
-    "@types/react-dom": "^19.2.1",
-    "@typescript-eslint/eslint-plugin": "^8.36.0",
-    "@typescript-eslint/parser": "^8.36.0",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
     "assert": "^2.1.0",
-    "autoprefixer": "^10.4.21",
-    "babel-jest": "^30.2.0",
+    "autoprefixer": "^10.4.27",
+    "babel-jest": "^30.3.0",
     "bootstrap": "^5.3.8",
-    "chromatic": "^13.3.0",
-    "css-loader": "^7.1.2",
+    "chromatic": "^15.3.0",
+    "css-loader": "^7.1.4",
     "deep-iterator": "^1.1.0",
     "eslint": "^9.37.0",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-storybook": "^9.1.10",
-    "globals": "^16.4.0",
-    "govuk-frontend": "^5.12.0",
-    "html-react-parser": "^5.2.6",
+    "eslint-plugin-storybook": "^10.3.0",
+    "globals": "^17.4.0",
+    "govuk-frontend": "^6.1.0",
+    "html-react-parser": "^5.2.17",
     "husky": "^9.1.7",
     "identity-obj-proxy": "^3.0.0",
-    "jest": "^30.2.0",
-    "jest-environment-jsdom": "^30.2.0",
-    "magicast": "^0.3.5",
+    "jest": "^30.3.0",
+    "jest-environment-jsdom": "^30.3.0",
+    "magicast": "^0.5.2",
     "pdfjs-dist": "^4.10.38",
-    "postcss": "^8.5.6",
-    "prettier": "^3.6.2",
-    "react": "^19.2.0",
+    "postcss": "^8.5.8",
+    "prettier": "^3.8.1",
+    "react": "^19.2.4",
     "react-bootstrap": "^2.10.10",
-    "react-dom": "^19.2.0",
+    "react-dom": "^19.2.4",
     "react-element-to-jsx-string": "^17.0.1",
-    "react-router": "^7.9.4",
-    "react-router-dom": "^7.9.4",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.52.4",
+    "react-router": "^7.13.1",
+    "react-router-dom": "^7.13.1",
+    "rimraf": "^6.1.3",
+    "rollup": "^4.59.0",
     "rollup-plugin-analyzer": "^4.0.0",
-    "rollup-plugin-dts": "^6.2.3",
+    "rollup-plugin-dts": "^6.4.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.2",
     "rollup-plugin-visualizer": "^6.0.4",
-    "sass": "^1.93.2",
-    "sass-loader": "^16.0.5",
+    "sass": "^1.98.0",
+    "sass-loader": "^16.0.7",
     "standard-version": "^9.5.0",
-    "storybook": "^9.1.10",
+    "storybook": "^10.3.0",
     "style-loader": "^4.0.0",
-    "stylelint": "^16.25.0",
-    "stylelint-config-idiomatic-order": "^10.0.0",
-    "stylelint-config-standard": "^39.0.1",
-    "stylelint-config-standard-scss": "^16.0.0",
-    "stylelint-order": "^7.0.0",
+    "stylelint": "^17.4.0",
+    "stylelint-config-recess-order": "^7.6.1",
+    "stylelint-config-standard": "^40.0.0",
+    "stylelint-config-standard-scss": "^17.0.0",
+    "stylelint-order": "^7.0.1",
     "tslib": "^2.8.1",
     "tsuml2": "^0.17.1",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.0",
-    "unplugin": "^2.3.10",
-    "webpack": "^5.102.1",
-    "@storybook/addon-docs": "^9.1.10"
+    "typescript-eslint": "^8.57.1",
+    "unplugin": "^3.0.0",
+    "webpack": "^5.105.4",
+    "@storybook/addon-docs": "^10.3.0"
   },
   "peerDependencies": {
-    "govuk-frontend": ">=5.8.0",
+    "govuk-frontend": ">=5.14.0",
     "react": ">=18.2.0",
     "react-dom": ">=18.2.0",
     "react-router-dom": ">=6.30.0"