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

package/dist/index.d.ts

@@ -88,6 +88,17 @@ interface LabelProps {
     isPageHeading?: boolean;
 }
 
+/**
+ * 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.
+ */
+interface FormGroupProps {
+    className?: string;
+}
+
 interface BooleanItem {
     id?: string;
     children?: React.ReactNode;
@@ -109,10 +120,7 @@ interface BooleanProps {
     className?: string;
     errorMessage?: ErrorMessageProps;
     fieldset?: FieldsetProps;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
+    formGroup?: FormGroupProps;
     hint?: HintProps;
     idPrefix?: string;
     items?: BooleanItem[];
@@ -290,10 +298,7 @@ interface DateInputProps {
     className?: string;
     errorMessage?: ErrorMessageProps;
     fieldset?: FieldsetProps;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
+    formGroup?: FormGroupProps;
     hint?: HintProps;
     id?: string;
     items?: Array<DateInputItem>;
@@ -411,10 +416,7 @@ declare const Fieldset: React$1.FC<FieldsetProps>;
 interface FileUploadProps extends React.InputHTMLAttributes<HTMLInputElement> {
     className?: string;
     errorMessage?: ErrorMessageProps;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
+    formGroup?: FormGroupProps;
     hint?: HintProps;
     label?: LabelProps;
     "aria-describedby"?: string;
@@ -487,7 +489,7 @@ interface HeaderProps extends HTMLAttributes<HTMLDivElement> {
     navigationLabel?: string;
     menuButtonLabel?: string;
     logo?: string;
-    removeGovUKHeader?: unknown;
+    removeGovUKHeader?: boolean;
     assetsPath?: string;
 }
 
@@ -500,24 +502,15 @@ declare const Hint: React$1.FC<HintProps & React$1.HTMLAttributes<HTMLOrSVGEleme
 interface InputProps {
     className?: string;
     "aria-describedby"?: string;
-    errorMessage?: object;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
-    hint?: object;
-    label?: object;
+    errorMessage?: ErrorMessageProps;
+    formGroup?: FormGroupProps;
+    hint?: HintProps;
+    label?: LabelProps;
     name?: string;
     id?: string;
     type: string;
-    prefix?: {
-        className?: string;
-        [key: string]: unknown;
-    };
-    suffix?: {
-        className?: string;
-        [key: string]: unknown;
-    };
+    prefix?: React.HTMLAttributes<HTMLDivElement>;
+    suffix?: React.HTMLAttributes<HTMLDivElement>;
 }
 
 declare const Input: React$1.FC<InputProps & React$1.InputHTMLAttributes<HTMLInputElement>>;
@@ -620,34 +613,16 @@ interface PanelProps extends HTMLAttributes<HTMLDivElement> {
 
 declare const Panel: React$1.FC<PanelProps>;
 
-interface PasswordInputLabelProps {
-    children?: React.ReactNode;
-    className?: string;
-    isPageHeading?: boolean;
-    [key: string]: unknown;
-}
 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;
-    };
+    errorMessage?: ErrorMessageProps;
     /** 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;
+    formGroup?: FormGroupProps;
+    hint?: HintProps;
+    label?: LabelProps;
     /** Input name attribute */
     name?: string;
     /** Input id attribute — also used to link label and aria-describedby */
@@ -743,10 +718,7 @@ interface SelectProps {
     className?: string;
     "aria-describedby"?: string;
     errorMessage?: ErrorMessageProps;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
+    formGroup?: FormGroupProps;
     hint?: HintProps;
     id?: string;
     items?: Option[];
@@ -881,12 +853,9 @@ interface TextareaProps extends TextareaHTMLAttributes<HTMLTextAreaElement> {
     className?: string;
     "aria-describedby"?: string;
     errorMessage?: ErrorMessageProps;
-    formGroup?: {
-        className?: string;
-        [key: string]: unknown;
-    };
-    hint?: object;
-    label?: object;
+    formGroup?: FormGroupProps;
+    hint?: HintProps;
+    label?: LabelProps;
     id?: string;
 }