@chris-c-brine/form-dialog 1.0.5 → 1.1.0

package/dist/hooks/useDialog.d.ts

@@ -1,9 +1,22 @@
+import { MouseEvent } from "react";
 export interface UseDialogProps {
     /** Initial open state of the dialog */
     open?: boolean;
-    /** Whether to keep the dialog mounted when closed */
+    /** Always keep the children in the DOM. */
     keepMounted?: boolean;
 }
+export interface UseDialogReturn {
+    /** Function to close the dialog */
+    closeDialog: () => void;
+    /** Function to open the dialog */
+    openDialog: (e?: MouseEvent) => void;
+    /** Props to spread onto the dialog component */
+    dialogProps: {
+        open: boolean;
+        onClose: () => void;
+        keepMounted: boolean;
+    };
+}
 /**
  * Hook for managing dialog state and providing dialog control functions
  *
@@ -11,6 +24,8 @@ export interface UseDialogProps {
  * functions to open and close the dialog, along with props that can be
  * spread onto a Material-UI Dialog component.
  *
+ * Restores focus to the opening element, but only after the dialog has fully closed.
+ *
  * @example
  * // Basic usage
  * const { openDialog, closeDialog, dialogProps } = useDialog();
@@ -21,17 +36,8 @@ export interface UseDialogProps {
  *
  * @example
  * // With initial configuration
- * const { dialogProps } = useDialog({ keepMounted: false });
- *
+ * const { dialogProps } = useDialog({ keepMounted: true});
  *
  * @param props - Optional configuration options
  */
-export declare const useDialog: (props?: UseDialogProps) => {
-    closeDialog: () => void;
-    openDialog: () => void;
-    dialogProps: {
-        open: boolean;
-        onClose: () => void;
-        keepMounted: boolean;
-    };
-};
+export declare const useDialog: (props?: UseDialogProps) => UseDialogReturn;

package/dist/hooks/useFormDialog.d.ts

@@ -2,7 +2,7 @@
  * Hook for accessing the FormDialog context values and functions
  *
  * This hook provides access to the form dialog state and controls managed by
- * the FormDialogProvider. It allows components to interact with dialog state,
+ * the FormDialogProvider. It allows components to interact with the dialog state,
  * including open/close status and form-wide disabled state.
  *
  * The context provides:

package/dist/hooks/usePersistForm.d.ts

@@ -0,0 +1,29 @@
+import { FieldValues, UseFormReturn } from "react-hook-form-mui";
+export type PersistedFormProviderProps<T extends FieldValues> = {
+    /**
+     * A unique key for the form
+     */
+    formName: string | undefined;
+    /**
+     * Represents the context of a form, which is used to manage the state and actions of the form.
+     * The context is typically provided by a form management library and used to handle form inputs,
+     * validation, and submission.
+     */
+    formContext: UseFormReturn<T, any, T> | UseFormReturn<T> | undefined;
+};
+/**
+ * Hook that enables form state persistence across sessions
+ *
+ * This hook connects a form to persistent storage (e.g., sessionStorage)
+ * allowing form values to be preserved when navigating away and returning.
+ * It works by watching form changes and syncing with a zustand store.
+ *
+ * Key features:
+ * - Persists form values during navigation or page reloads
+ * - Automatically restores saved values when form is rendered
+ * - Debounced updates to avoid excessive storage operations
+ * - Only saves changed fields, not the entire form state
+ * - Automatically clears storage when form values match defaults
+ *
+ */
+export declare const usePersistForm: <T extends FieldValues>({ formName, formContext }: PersistedFormProviderProps<T>) => void;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./components";
-export * from "./utils";
-export { usePersistedForm, useFormDialog, useDialog } from "./hooks";
+export { usePersistForm, useFormDialog, useDialog } from "./hooks";
 export { FormDialogProvider } from "./state/FormDialogProvider";