@chris-c-brine/form-dialog 1.1.7 → 1.1.8

package/dist/types.d.ts

@@ -1,33 +1,43 @@
-import type { ButtonProps, DialogActionsProps, DialogContentProps, DialogProps, DialogTitleProps, GridProps, PaperProps } from "@mui/material";
-import { type Dispatch, MouseEvent, PropsWithChildren, ReactNode, type SetStateAction } from "react";
-import { FieldValues, type FormContainerProps, UseFormReturn } from "react-hook-form-mui";
-import type { FieldValue } from "react-hook-form";
+import type { ButtonProps, CircularProgressProps, DialogActionsProps, DialogContentProps, DialogProps, DialogTitleProps, GridProps, PaperProps } from "@mui/material";
+import { MouseEvent, PropsWithChildren, ReactNode, type Dispatch, type SetStateAction } from "react";
+import { FieldValues, type FormContainerProps } from "react-hook-form-mui";
 /**
  * Props for the FormCancelButton component
  */
 export type FormCancelButtonProps = Omit<ButtonProps, "onClick"> & {
-    /** Whether to maintain any attempt counters when canceling */
-    keepCount?: boolean;
+    /**
+     * Display variant for the button, determining whether to show icon, text, or both.
+     * Inherited from FormDialogActionsProps.
+     */
+    iconVariant?: FormDialogActionsProps['variant'];
 };
 /**
  * Props for the FormResetButton component
  */
 export type FormResetButtonProps = Omit<ButtonProps, "onClick"> & {
     /**
-     * Whether to preserve the submission count when resetting the form
-     * When true, the form's submitCount will be maintained after reset
+     * Display variant for the button.
      */
-    keepCount?: boolean;
+    iconVariant?: FormDialogActionsProps['variant'];
     /**
      * A unique identifier for the form associated with this reset button
      * When provided, also clears persisted form data from storage
      */
     formKey?: string;
+    /**
+     * Whether to preserve the submission count when resetting the form.
+     * When true, the form's submitCount will be maintained after reset.
+     */
+    keepCount?: boolean;
 };
 /**
  * Props for the FormSubmitButton component
  */
 export type FormSubmitButtonProps = Omit<LoadingButtonProps, "onClick"> & {
+    /**
+     * Display variant for the button.
+     */
+    iconVariant?: FormDialogActionsProps['variant'];
     /**
      * Whether to show the submission attempt count badge
      */
@@ -47,12 +57,16 @@ export type LoadingButtonProps = ButtonProps & {
      * When false, displays a loading spinner; when true or undefined, displays normal content
      */
     loading?: boolean;
+    loadingIconProps?: CircularProgressProps;
     /**
      * Optional icon to display when the button is not in loading state
      * Can be used to provide a visual indicator of the button's action
      */
     altIcon?: ReactNode;
 };
+/**
+ * Props for the BaseDialog component, extending BlackoutDialog with standard layout sections.
+ */
 export type BaseDialogProps = BlackoutDialogProps & {
     /**
      * Title content for the dialog
@@ -85,6 +99,9 @@ export type BaseDialogProps = BlackoutDialogProps & {
      */
     closeButton?: ReactNode;
 };
+/**
+ * Props for the BaseDialog component, extending BlackoutDialog with standard layout sections.
+ */
 export type BlackoutDialogProps = Omit<DialogProps, "title"> & {
     /**
      * An optional unique string identifier
@@ -150,28 +167,11 @@ export type CommonFormProps<T extends FieldValues> = {
      * This includes settings for form state, validation, and submission handling
      */
     formProps: FormContainerProps<T>;
-    /**
-     * Optional key to use for form state persistence
-     * When provided, the form state will be persisted in
-     * session storage with a fallback to local storage (TODO: make configurable)
-     * and restored on form reload/mount.
-     */
-    persistKey?: string;
 };
 /**
  * Props for the PaperForm component
  */
 export type PaperFormProps<T extends FieldValues> = PaperProps & CommonFormProps<T>;
-/**
- * Props for the PersistForm component
- */
-export interface PersistFormProps extends PropsWithChildren {
-    /**
-     * A unique identifier for the form
-     * This key is used to store and retrieve form data in the persistence layer
-     */
-    formName: string;
-}
 export interface UseDialogProps {
     /** Initial open state of the dialog */
     open?: boolean;
@@ -193,23 +193,6 @@ export interface UseDialogReturn {
 export type UseMaxAttemptProps = {
     maxAttempts?: number;
 };
-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;
-};
-export interface FormStore<T extends FieldValues> {
-    formData: Partial<Record<keyof T, FieldValue<T>>>;
-    updateFormData: <K extends keyof T>(key: K, value: FieldValue<T>) => void;
-    resetFormData: (key?: keyof T) => void;
-}
 export type FormDialogContextType = {
     open?: boolean;
     closeDialog?: DialogProps['onClose'];

package/dist/utils/applyDefaultFormDialogProps.d.ts

@@ -316,8 +316,9 @@ export declare function applyDefaultFormDialogProps({ resetProps, submitProps, g
         onTransitionStart?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         onTransitionStartCapture?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         component?: React.ElementType | undefined;
-        keepCount: boolean;
+        iconVariant?: "text" | "icon" | "iconText" | undefined;
         formKey?: string | undefined;
+        keepCount: boolean;
     };
     gridContainerProps: {
         component?: React.ElementType;
@@ -1087,7 +1088,7 @@ export declare function applyDefaultFormDialogProps({ resetProps, submitProps, g
         onTransitionStart?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         onTransitionStartCapture?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         component?: React.ElementType;
-        keepCount?: boolean;
+        iconVariant?: import("../types").FormDialogActionsProps["variant"];
     };
     submitButtonProps: {
         className?: string;
@@ -1405,7 +1406,9 @@ export declare function applyDefaultFormDialogProps({ resetProps, submitProps, g
         onTransitionStart?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         onTransitionStartCapture?: import("react").TransitionEventHandler<HTMLButtonElement> | undefined;
         component?: React.ElementType;
+        loadingIconProps?: import("@mui/material").CircularProgressProps;
         altIcon?: ReactNode;
+        iconVariant?: import("../types").FormDialogActionsProps["variant"];
         showAttempts?: boolean;
         maxAttempts?: number;
     };

package/dist/utils/index.d.ts

@@ -1,4 +1,3 @@
 export { default as hasMaxAttempts } from "./hasMaxAttempts";
-export { default as deepCompare } from "./deepCompare";
 export * from "./applyDefaultFormDialogProps";
 export * from "./ThemeBridge";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chris-c-brine/form-dialog",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Easy Form Dialogs with a persistable state!",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,24 +15,22 @@
   },
   "keywords": [
     "RHF Dialog",
-    "Persisable Dialogs",
+    "Form Dialog",
     "typescript",
-    "zustand",
     "react-hook-form-mui"
   ],
   "dependencies": {
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@emotion/react": "^11.14.0",
-    "@emotion/styled": "^11.14.0",
-    "@mui/icons-material": "^7.1.0",
-    "@mui/material": "^7.1.0",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
-    "react-hook-form": "^7.56.2",
-    "react-hook-form-mui": "^7.6.0 || ^8.0.0",
-    "zustand": "^5.0.4"
+    "@emotion/react": "^11.0.0",
+    "@emotion/styled": "^11.0.0",
+    "@mui/icons-material": "^7.0.0",
+    "@mui/material": "^7.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-hook-form": "^7.0.0",
+    "react-hook-form-mui": "^7.0.0 || ^8.0.0"
   },
   "devDependencies": {
     "@emotion/react": "^11.14.0",
@@ -53,7 +51,6 @@
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "tslib": "^2.8.1",
     "typescript": "^5.8.3",
-    "zustand": "^5.0.4",
     "@types/node": "^22.15.17"
   },
   "author": "Christopher Brine",