@abgov/react-components 6.4.1 → 6.5.0-alpha.1

package/lib/form/fieldset.d.ts

@@ -0,0 +1,26 @@
+import { GoabFieldsetOnChangeDetail, GoabFieldsetOnContinueDetail, GoabFormDispatchOn, Margins } from '@abgov/ui-components-common';
+import { ReactNode } from 'react';
+
+interface WCProps extends Margins {
+    ref?: React.RefObject<HTMLElement | null>;
+    id?: string;
+    "section-title"?: string;
+    "dispatch-on"?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-fieldset": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface GoabFieldsetProps extends Margins {
+    id?: string;
+    sectionTitle?: string;
+    dispatchOn?: GoabFormDispatchOn;
+    onContinue?: (event: GoabFieldsetOnContinueDetail) => void;
+    onChange?: (event: GoabFieldsetOnChangeDetail) => void;
+    children: ReactNode;
+}
+export declare function GoabFieldset({ id, sectionTitle, dispatchOn, onContinue, onChange, children, }: GoabFieldsetProps): import("react/jsx-runtime").JSX.Element;
+export default GoabFieldset;

package/lib/form/public-form-page.d.ts

@@ -0,0 +1,59 @@
+import { GoabPublicFormPageButtonVisibility, GoabPublicFormPageOnFieldsetChangeDetail, GoabPublicFormPageOnCompleteDetail, GoabPublicFormPageOnContinueDetail, GoabPublicFormPageStep, Margins } from '@abgov/ui-components-common';
+import { ReactNode } from 'react';
+
+interface WCProps extends Margins {
+    ref?: React.RefObject<HTMLElement | null>;
+    id?: string;
+    heading?: string;
+    "sub-heading"?: string;
+    "section-title"?: string;
+    "back-url"?: string;
+    type?: string;
+    "button-text"?: string;
+    "button-visibility"?: string;
+    first?: boolean;
+    last?: boolean;
+    "summary-heading"?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-public-form-page": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface GoabPublicFormPageProps extends Margins {
+    id?: string;
+    heading?: string;
+    subHeading?: string;
+    summaryHeading?: string;
+    sectionTitle?: string;
+    backUrl?: string;
+    type?: GoabPublicFormPageStep;
+    buttonText?: string;
+    buttonVisibility?: GoabPublicFormPageButtonVisibility;
+    first?: boolean;
+    last?: boolean;
+    /**
+     * Triggered when the form page continues to the next step
+     * @param event - The continue event details
+     */
+    onContinue?: (event: GoabPublicFormPageOnContinueDetail) => void;
+    /**
+     * Triggered when the user clicks the back link
+     */
+    onBack?: () => void;
+    /**
+     * Triggered when the form fieldset content changes
+     * @param event - The fieldset change event details
+     */
+    onFieldsetChange?: (event: GoabPublicFormPageOnFieldsetChangeDetail) => void;
+    /**
+     * Triggered when the form is completed
+     * @param event - The complete event details
+     */
+    onComplete?: (event: GoabPublicFormPageOnCompleteDetail) => void;
+    children: ReactNode;
+}
+export declare function GoabPublicFormPage({ id, heading, subHeading, summaryHeading, sectionTitle, backUrl, type, buttonText, buttonVisibility, first, last, onContinue, onBack, onFieldsetChange, onComplete, children, mt, mr, mb, ml, }: GoabPublicFormPageProps): import("react/jsx-runtime").JSX.Element;
+export default GoabPublicFormPage;

package/lib/form/public-form-summary.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+interface WCProps {
+    ref?: React.RefObject<HTMLElement | null>;
+    heading?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-public-form-summary": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface GoabPublicFormSummaryProps {
+    heading?: string;
+}
+export declare function GoabPublicFormSummary({ heading, }: GoabPublicFormSummaryProps): import("react/jsx-runtime").JSX.Element;
+export default GoabPublicFormSummary;

package/lib/form/public-form.d.ts

@@ -0,0 +1,25 @@
+import { GoabFormState, GoabPublicFormOnInitDetail, GoabPublicFormStatus } from '@abgov/ui-components-common';
+import { ReactNode } from 'react';
+
+interface WCProps {
+    ref?: React.RefObject<HTMLElement | null>;
+    status?: string;
+    name?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-public-form": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface GoabPublicFormProps {
+    status?: GoabPublicFormStatus;
+    name?: string;
+    onInit?: (event: GoabPublicFormOnInitDetail) => void;
+    onComplete?: (event: GoabFormState) => void;
+    onStateChange?: (event: GoabFormState) => void;
+    children: ReactNode;
+}
+export declare function GoabPublicForm({ status, name, onInit, onComplete, onStateChange, children, }: GoabPublicFormProps): import("react/jsx-runtime").JSX.Element;
+export default GoabPublicForm;

package/lib/form-item/form-item.d.ts

@@ -8,6 +8,8 @@ interface WCProps extends Margins {
     error?: string;
     helptext?: string;
     maxwidth?: string;
+    "public-form-summary-order"?: number;
+    name?: string;
     id?: string;
     testid?: string;
 }
@@ -25,9 +27,17 @@ export interface GoabFormItemProps extends Margins {
     error?: string | React.ReactNode;
     helpText?: string | React.ReactNode;
     maxWidth?: string;
+    /**
+     * Public form: to arrange fields in the summary
+     */
+    publicFormSummaryOrder?: number;
+    /**
+     * Public form: allow to override the label value within the form-summary to provide a shorter description of the value
+     */
+    name?: string;
     children?: React.ReactNode;
     testId?: string;
     id?: string;
 }
-export declare function GoabFormItem({ children, helpText, error, requirement, label, labelSize, maxWidth, mt, mr, mb, ml, testId, id, }: GoabFormItemProps): JSX.Element;
+export declare function GoabFormItem({ children, helpText, error, requirement, label, labelSize, maxWidth, publicFormSummaryOrder, name, mt, mr, mb, ml, testId, id, }: GoabFormItemProps): JSX.Element;
 export default GoabFormItem;

package/lib/input/input.d.ts

@@ -68,7 +68,7 @@ type OnFocus<T = string> = (detail: GoabInputOnFocusDetail<T>) => void;
 type OnBlur<T = string> = (detail: GoaInputOnBlurDetail<T>) => void;
 type OnKeyPress<T = string> = (detail: GoabInputOnKeyPressDetail<T>) => void;
 export interface GoabInputProps extends BaseProps {
-    onChange: OnChange<string>;
+    onChange?: OnChange<string>;
     value?: string;
     min?: number | string;
     max?: number | string;
@@ -78,7 +78,7 @@ export interface GoabInputProps extends BaseProps {
     onKeyPress?: OnKeyPress<string>;
 }
 interface GoabNumberInputProps extends BaseProps {
-    onChange: OnChange<number>;
+    onChange?: OnChange<number>;
     value?: number;
     min?: number;
     max?: number;
@@ -88,7 +88,7 @@ interface GoabNumberInputProps extends BaseProps {
     onKeyPress?: OnKeyPress<number>;
 }
 interface GoabDateInputProps extends BaseProps {
-    onChange: OnChange<GoabDate>;
+    onChange?: OnChange<GoabDate>;
     value?: GoabDate;
     min?: GoabDate;
     max?: GoabDate;

package/lib/radio-group/radio-group.d.ts

@@ -6,6 +6,7 @@ interface WCProps extends Margins {
     ref: React.RefObject<HTMLElement | null>;
     name: string;
     value?: string;
+    id?: string;
     orientation?: GoabRadioGroupOrientation;
     disabled?: string;
     error?: string;
@@ -22,13 +23,14 @@ declare module "react" {
 export interface GoabRadioGroupProps extends Margins {
     name: string;
     value?: string;
+    id?: string;
     disabled?: boolean;
     orientation?: GoabRadioGroupOrientation;
     testId?: string;
     error?: boolean;
     ariaLabel?: string;
     children?: React.ReactNode;
-    onChange: (detail: GoabRadioGroupOnChangeDetail) => void;
+    onChange?: (detail: GoabRadioGroupOnChangeDetail) => void;
 }
-export declare function GoabRadioGroup({ name, value, children, orientation, disabled, error, testId, ariaLabel, mt, mr, mb, ml, onChange, }: GoabRadioGroupProps): JSX.Element;
+export declare function GoabRadioGroup({ name, value, children, orientation, disabled, error, id, testId, ariaLabel, mt, mr, mb, ml, onChange, }: GoabRadioGroupProps): JSX.Element;
 export default GoabRadioGroup;

package/lib/textarea/textarea.d.ts

@@ -39,7 +39,7 @@ export interface GoabTextAreaProps extends Margins {
     ariaLabel?: string;
     countBy?: GoabTextAreaCountBy;
     maxCount?: number;
-    onChange: (event: GoabTextAreaOnChangeDetail) => void;
+    onChange?: (event: GoabTextAreaOnChangeDetail) => void;
     onKeyPress?: (event: GoabTextAreaOnKeyPressDetail) => void;
 }
 export declare function GoabTextArea({ name, value, placeholder, rows, readOnly, disabled, countBy, maxCount, width, maxWidth, testId, error, ariaLabel, mt, mr, mb, ml, onChange, onKeyPress, }: GoabTextAreaProps): JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/react-components",
-  "version": "6.4.1",
+  "version": "6.5.0-alpha.1",
   "description": "Government of Alberta - UI components for React",
   "bugs": {
     "url": "https://github.com/GovAlta/ui-components/issues"

package/lib/fieldset/fieldset.d.ts

@@ -1,30 +0,0 @@
-import { GoabFieldsetOnContinueDetail, Margins } from '@abgov/ui-components-common';
-import { ReactNode } from 'react';
-
-interface WCProps extends Margins {
-    ref?: React.RefObject<HTMLElement | null>;
-    id: string;
-    heading?: string;
-    buttontext?: string;
-    last?: string;
-    first?: string;
-}
-declare module "react" {
-    namespace JSX {
-        interface IntrinsicElements {
-            "goa-public-form-page": WCProps & React.HTMLAttributes<HTMLElement>;
-        }
-    }
-}
-interface GoabFieldsetProps extends Margins {
-    id: string;
-    first?: boolean;
-    last?: boolean;
-    heading?: string;
-    buttonText?: string;
-    errors?: Record<string, string>;
-    onContinue?: (event: GoabFieldsetOnContinueDetail) => boolean | void | undefined;
-    children: ReactNode;
-}
-export declare function GoabFieldset({ heading, buttonText, id, onContinue, children, mt, mr, mb, ml, first, last, }: GoabFieldsetProps): import("react/jsx-runtime").JSX.Element;
-export default GoabFieldset;