@abgov/ui-components-common 1.4.0 → 1.5.0-alpha.2

package/lib/common.d.ts

@@ -297,16 +297,8 @@ export interface GoabFieldsetOnContinueDetail {
     cancelled: boolean;
 }
 export type GoabPublicFormStatus = "initializing" | "complete";
-export type GoabPublicFormOnInitDetail = {
-    el: HTMLFormElement;
-};
 export type GoabPublicFormPageStep = "step" | "summary" | "multistep";
 export type GoabPublicFormPageButtonVisibility = "visible" | "hidden";
-export type GoabPublicFormPageOnContinueDetail = {
-    el: HTMLElement;
-    state: Record<string, GoabFieldsetItemState>;
-    cancelled: boolean;
-};
 export type GoabPublicFormPageOnFieldsetChangeDetail = {
     id: string;
     state: {

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

@@ -1,6 +1,5 @@
-import { GoabFieldsetItemValue, GoabFormDispatchOn, GoabPublicFormOnInitDetail, GoabPublicFormPageOnContinueDetail } from './common';
 import { FieldsetItemState, FieldValidator } from './validators';
-
+import { GoabFieldsetItemValue, GoabFormDispatchOn } from './common';
 export type FormStatus = "not-started" | "incomplete" | "complete";
 export type AppState<T> = {
     uuid: string;
@@ -31,7 +30,7 @@ export declare class PublicFormController<T> {
     _formData?: Record<string, string>;
     _formRef?: HTMLElement;
     constructor(type: "details" | "list");
-    init(e: GoabPublicFormOnInitDetail): void;
+    init(e: Event): void;
     initList(e: Event): void;
     initState(state?: string | AppState<T> | AppState<T>[], callback?: () => void): void;
     updateListState(e: Event): void;
@@ -39,7 +38,7 @@ export declare class PublicFormController<T> {
     getStateList(): Record<string, string>[];
     getStateValue(group: string, key: string): string;
     continueTo(next: T | undefined): void;
-    validate(e: GoabPublicFormPageOnContinueDetail, field: string, validators: FieldValidator[], options?: {
+    validate(e: Event, field: string, validators: FieldValidator[], options?: {
         grouped: boolean;
     }): [boolean, GoabFieldsetItemValue];
     /**
@@ -51,7 +50,7 @@ export declare class PublicFormController<T> {
      * @param {FieldValidator[]} validators - An array of validator functions to apply to the fields.
      * @return {[number, Record<string, boolean>]} - Returns back the number of fields that passed and a record of the fields and their pass status.
      */
-    validateGroup(e: GoabPublicFormPageOnContinueDetail, fields: string[], validators: FieldValidator[]): [number, Record<string, boolean>];
+    validateGroup(e: Event, fields: string[], validators: FieldValidator[]): [number, Record<string, boolean>];
     edit(index: number): void;
     remove(index: number): void;
     clean(data: AppState<T>): Record<string, unknown>;

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

@@ -0,0 +1,14 @@
+import { PublicFormController, AppState } from './public-form-controller';
+import { GoabFieldsetItemValue } from './common';
+import { FieldValidator } from './validators';
+export declare function usePublicFormController<T>(type?: "details" | "list"): {
+    state: AppState<T> | AppState<T>[] | undefined;
+    init: (e: Event) => void;
+    initList: (e: Event) => void;
+    initState: (state?: string | AppState<T> | AppState<T>[], callback?: () => void) => void;
+    continueTo: (next: T | undefined) => void;
+    validate: (e: Event, field: string, validators: FieldValidator[]) => [boolean, GoabFieldsetItemValue];
+    getStateValue: (group: string, key: string) => string;
+    getStateList: () => Record<string, string>[];
+    controller: PublicFormController<T>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/ui-components-common",
-  "version": "1.4.0",
+  "version": "1.5.0-alpha.2",
   "bugs": {
     "url": "https://github.com/GovAlta/ui-components/issues"
   },