@hmlr/govuk-react-components-library 1.2.2 → 1.3.0

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

@@ -0,0 +1,19 @@
+import { ErrorMessageProps } from "../ErrorMessage/ErrorMessage.types";
+import { HintProps } from "../Hint/Hint.types";
+import { LabelProps } from "../Label/Label.types";
+import { FormGroupProps } from "../common.types";
+export interface Option {
+    reactListKey?: string | number;
+    children: React.ReactNode;
+    [key: string]: unknown;
+}
+export interface SelectProps {
+    className?: string;
+    "aria-describedby"?: string;
+    errorMessage?: ErrorMessageProps;
+    formGroup?: FormGroupProps;
+    hint?: HintProps;
+    id?: string;
+    items?: Option[];
+    label: LabelProps;
+}

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

@@ -0,0 +1 @@
+export { default as Select } from "./Select";

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

@@ -0,0 +1,4 @@
+import React, { HTMLAttributes } from "react";
+import { ServiceNavigationProps } from "./ServiceNavigation.types";
+declare const ServiceNavigation: React.FC<ServiceNavigationProps & HTMLAttributes<HTMLDivElement>>;
+export default ServiceNavigation;

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

@@ -0,0 +1,21 @@
+import { To } from "react-router";
+export interface NavigationItem {
+    active?: boolean;
+    className?: string;
+    children?: React.ReactNode;
+    href?: string;
+    to?: To;
+    reactListKey?: string | number;
+    [key: string]: unknown;
+}
+export interface ServiceNavigationProps {
+    className?: string;
+    containerClassName?: string;
+    menuButtonLabel?: string;
+    navigation?: NavigationItem[];
+    navigationClassName?: string;
+    navigationLabel?: string;
+    serviceName?: string;
+    serviceUrlHref?: string;
+    serviceUrlTo?: To;
+}

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

@@ -0,0 +1 @@
+export { default as ServiceNavigation } from "./ServiceNavigation";

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

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

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { SkipLinkProps } from "./SkipLink.types";
+declare const SkipLink: React.FC<SkipLinkProps & React.HTMLAttributes<HTMLOrSVGElement>>;
+export default SkipLink;

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

@@ -0,0 +1,5 @@
+export interface SkipLinkProps {
+    href: string;
+    className: string;
+    children?: React.ReactNode;
+}

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

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

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { SummaryListProps } from "./SummaryList.types";
+declare const SummaryList: React.FC<SummaryListProps>;
+export default SummaryList;

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

@@ -0,0 +1,22 @@
+import { Action } from "../ActionLink/ActionLink.types";
+export interface Row {
+    reactListKey?: string;
+    key?: {
+        className?: string;
+        children: React.ReactNode;
+    };
+    value?: {
+        className?: string;
+        children: React.ReactNode;
+    };
+    actions?: {
+        items: Action[];
+        className?: string;
+    };
+    className?: string;
+}
+export interface SummaryListProps {
+    className?: string;
+    rows?: Row[];
+    [key: string]: unknown;
+}

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

@@ -0,0 +1 @@
+export { default as SummaryList } from "./SummaryList";

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { TableProps } from "./Table.types";
+declare const Table: React.FC<TableProps>;
+export default Table;

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

@@ -0,0 +1,21 @@
+import { HTMLAttributes } from "react";
+export interface TableItem {
+    className?: string;
+    format?: string;
+    children: React.ReactNode;
+    reactListKey?: string | number;
+    [key: string]: unknown;
+}
+export interface TableRow {
+    cells: TableItem[];
+    reactListKey?: string | number;
+}
+export interface TableProps extends HTMLAttributes<HTMLTableElement> {
+    caption?: string;
+    captionClassName?: string;
+    firstCellIsHeader?: boolean;
+    className?: string;
+    head?: TableItem[];
+    rows?: TableRow[];
+    footer?: TableItem[];
+}

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

@@ -0,0 +1 @@
+export { default as Table } from "./Table";

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

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

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { TabsProps } from "./Tabs.types";
+declare const Tabs: React.FC<TabsProps>;
+export default Tabs;

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

@@ -0,0 +1,14 @@
+import { HTMLAttributes } from "react";
+export interface TabItem {
+    id?: string;
+    label: string;
+    panel: HTMLAttributes<HTMLDivElement>;
+    [key: string]: unknown;
+}
+export interface TabsProps extends HTMLAttributes<HTMLDivElement> {
+    className?: string;
+    id: string;
+    idPrefix?: string;
+    items: TabItem[];
+    title?: string;
+}

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

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

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { TagProps } from "./Tag.types";
+declare const Tag: React.FC<TagProps & React.HTMLAttributes<HTMLOrSVGElement>>;
+export default Tag;

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

@@ -0,0 +1,4 @@
+export interface TagProps {
+    className?: string;
+    children?: React.ReactNode;
+}

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

@@ -0,0 +1 @@
+export { default as Tag } from "./Tag";

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

@@ -0,0 +1,4 @@
+import React, { HTMLAttributes } from "react";
+import { TaskListProps } from "./TaskList.types";
+declare const TaskList: React.FC<TaskListProps & HTMLAttributes<HTMLUListElement>>;
+export default TaskList;

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

@@ -0,0 +1,21 @@
+import React from "react";
+import { HintProps } from "../Hint/Hint.types";
+export interface TaskListItemProps {
+    title: {
+        children: React.ReactNode;
+    };
+    hint: HintProps;
+    status: {
+        children?: React.ReactNode;
+        tag?: {
+            children: React.ReactNode;
+        };
+    };
+    href?: string;
+    [key: string]: unknown;
+}
+export interface TaskListProps {
+    className?: string;
+    idPrefix?: string;
+    items: TaskListItemProps[];
+}

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

@@ -0,0 +1 @@
+export { default as TaskList } from "./TaskList";

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { TextareaProps } from "./Textarea.types";
+declare const Textarea: React.FC<TextareaProps>;
+export default Textarea;

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

@@ -0,0 +1,14 @@
+import { TextareaHTMLAttributes } from "react";
+import { ErrorMessageProps } from "../ErrorMessage/ErrorMessage.types";
+import { HintProps } from "../Hint/Hint.types";
+import { LabelProps } from "../Label/Label.types";
+import { FormGroupProps } from "../common.types";
+export interface TextareaProps extends TextareaHTMLAttributes<HTMLTextAreaElement> {
+    className?: string;
+    "aria-describedby"?: string;
+    errorMessage?: ErrorMessageProps;
+    formGroup?: FormGroupProps;
+    hint?: HintProps;
+    label?: LabelProps;
+    id?: string;
+}

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

@@ -0,0 +1 @@
+export { default as Textarea } from "./Textarea";

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

@@ -0,0 +1,4 @@
+import React from "react";
+import { WarningInfoProps } from "./WarningInfo.types";
+declare const WarningInfo: React.FC<WarningInfoProps>;
+export default WarningInfo;

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

@@ -0,0 +1,8 @@
+export interface WarningInfoProps {
+    messageHeading?: string;
+    message?: string;
+    advice?: string;
+    applicationName?: string;
+    applicationRoute?: string;
+    basePageName?: string;
+}

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

@@ -0,0 +1 @@
+export { default as WarningInfo } from "./WarningInfo";

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

@@ -0,0 +1,4 @@
+import React, { HTMLAttributes } from "react";
+import { WarningTextProps } from "./WarningText.types";
+declare const WarningText: React.FC<WarningTextProps & HTMLAttributes<HTMLDivElement>>;
+export default WarningText;

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

@@ -0,0 +1,4 @@
+export interface WarningTextProps {
+    children?: React.ReactNode;
+    className?: string;
+}

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

@@ -0,0 +1 @@
+export { default as WarningText } from "./WarningText";

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

@@ -0,0 +1,10 @@
+/**
+ * The `formGroup` prop accepted by form-field components (Input, Textarea,
+ * Select, Boolean, DateInput, PasswordInput, FileUpload). Only `className`
+ * is ever read by any of them - it's applied to the wrapping
+ * `govuk-form-group` div, nothing else is spread from it - so unlike props
+ * that genuinely forward arbitrary HTML attributes, this has no catch-all.
+ */
+export interface FormGroupProps {
+    className?: string;
+}

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

@@ -0,0 +1,51 @@
+export * from "./Accordion";
+export * from "./ActionLink";
+export * from "./BackLink";
+export * from "./Boolean";
+export * from "./Breadcrumbs";
+export * from "./Button";
+export * from "./CardColumn";
+export * from "./CardLayout";
+export * from "./CharacterCount";
+export * from "./Checkboxes";
+export * from "./CookieBanner";
+export * from "./DataNavigation";
+export * from "./DateInput";
+export * from "./Details";
+export * from "./DifferenceNavigation";
+export * from "./ErrorBoundary";
+export * from "./ErrorMessage";
+export * from "./ErrorSummary";
+export * from "./ExitThisPage";
+export * from "./Fieldset";
+export * from "./FileUpload";
+export * from "./Footer";
+export * from "./Header";
+export * from "./Hint";
+export * from "./Input";
+export * from "./InsetText";
+export * from "./Label";
+export * from "./Landing";
+export * from "./LinkWithRef";
+export * from "./Loading";
+export * from "./Main";
+export * from "./NotFoundPage";
+export * from "./NotificationBanner";
+export * from "./Pagination";
+export * from "./Panel";
+export * from "./PasswordInput";
+export * from "./PDFViewer";
+export * from "./PhaseBanner";
+export * from "./ProblemWithService";
+export * from "./Radios";
+export * from "./Select";
+export * from "./ServiceNavigation";
+export * from "./SkipLink";
+export * from "./SummaryList";
+export * from "./Table";
+export * from "./Tabs";
+export * from "./Tag";
+export * from "./TaskList";
+export * from "./Textarea";
+export * from "./WarningInfo";
+export * from "./WarningText";

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

@@ -0,0 +1,3 @@
+import type { DynamicConfig } from "./types";
+export declare const defineStories: (config: DynamicConfig) => DynamicConfig;
+export * from "./types";

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

@@ -0,0 +1,37 @@
+import { ArgTypes, Tag } from "storybook/internal/csf";
+type AnyJson = boolean | number | string | null | Array<AnyJson> | JsonMap | React.ReactNode | undefined;
+interface JsonMap {
+    [key: string]: AnyJson;
+}
+interface AnnotationsConfig {
+    parameters?: JsonMap;
+    args?: JsonMap;
+    argTypes?: ArgTypes;
+    tags?: Tag[];
+}
+export interface MetaConfig extends AnnotationsConfig {
+    title?: string;
+}
+export interface StoryConfig extends AnnotationsConfig {
+    name?: string;
+}
+export type StoryConfigs = Record<string, StoryConfig>;
+export interface DynamicConfig {
+    baseCsf: string;
+    storiesCsf?: string;
+    stories?: () => Promise<StoryConfigs> | StoryConfigs;
+}
+export interface ComponentFixture {
+    name: string;
+    options?: object;
+    hidden?: boolean;
+    description?: string;
+    previewLayoutModifiers?: unknown[];
+    screenshot?: boolean;
+    html?: string;
+}
+export interface ComponentFixtureRoot {
+    component: string;
+    fixtures: ComponentFixture[];
+}
+export {};

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,3 @@
+import { ComponentFixture, ComponentFixtureRoot } from "../dynamics";
+export default function processExampleData(data: unknown, componentName: string): Array<ComponentFixture>;
+export declare function extractShownFixtures(fixtures: ComponentFixtureRoot): Array<ComponentFixture>;

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

@@ -0,0 +1,5 @@
+import type { ComponentFixtureRoot, StoryConfigs } from "../dynamics";
+export declare function loadFixturesAsJson(fileLocation: string): Promise<any>;
+export declare function storiesFromFixtures(fixtures: ComponentFixtureRoot): StoryConfigs;
+export declare function storiesFromFixturesSCF(fixtures: ComponentFixtureRoot, hasConfig?: boolean): string;
+export declare function createBaseCSF(fixtureName: string, hasConfig?: boolean): string;

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

@@ -0,0 +1,2 @@
+export declare function titleCase(str: string): string;
+export declare function titleCaseNoSpace(str: string): string;

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

@@ -0,0 +1,5 @@
+import { FC } from "react";
+import { WithRefProps } from "./WithReference.types";
+declare const WithRef: FC<WithRefProps>;
+declare const WithItemRefs: FC<WithRefProps>;
+export { WithRef, WithItemRefs };

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

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