@mantine/form 7.7.2 → 7.8.0

package/lib/hooks/use-form-status/use-form-status.d.ts

@@ -0,0 +1,29 @@
+import { ClearFieldDirty, FormMode, FormStatus, GetFieldStatus, ResetStatus, SetFieldDirty, SetFieldTouched } from '../../types';
+import type { $FormValues } from '../use-form-values/use-form-values';
+export interface $FormStatus<Values extends Record<string, any>> {
+    touchedState: FormStatus;
+    dirtyState: FormStatus;
+    touchedRef: React.MutableRefObject<FormStatus>;
+    dirtyRef: React.MutableRefObject<FormStatus>;
+    setTouched: React.Dispatch<React.SetStateAction<FormStatus>>;
+    setDirty: React.Dispatch<React.SetStateAction<FormStatus>>;
+    resetDirty: ResetStatus;
+    resetTouched: ResetStatus;
+    isTouched: GetFieldStatus<Values>;
+    setFieldTouched: SetFieldTouched<Values>;
+    setFieldDirty: SetFieldDirty<Values>;
+    setTouchedState: React.Dispatch<React.SetStateAction<FormStatus>>;
+    setDirtyState: React.Dispatch<React.SetStateAction<FormStatus>>;
+    clearFieldDirty: ClearFieldDirty;
+    isDirty: GetFieldStatus<Values>;
+    getDirty: () => FormStatus;
+    getTouched: () => FormStatus;
+}
+interface UseFormStatusInput<Values extends Record<string, any>> {
+    initialDirty: FormStatus;
+    initialTouched: FormStatus;
+    mode: FormMode;
+    $values: $FormValues<Values>;
+}
+export declare function useFormStatus<Values extends Record<string, any>>({ initialDirty, initialTouched, mode, $values, }: UseFormStatusInput<Values>): $FormStatus<Values>;
+export {};

package/lib/hooks/use-form-values/use-form-values.d.ts

@@ -0,0 +1,38 @@
+import { FormMode } from '../../types';
+export interface $FormValues<Values extends Record<PropertyKey, any>> {
+    initialized: React.MutableRefObject<boolean>;
+    stateValues: Values;
+    refValues: React.MutableRefObject<Values>;
+    valuesSnapshot: React.MutableRefObject<Values>;
+    setValues: (payload: SetValuesInput<Values>) => void;
+    setFieldValue: (payload: SetFieldValueInput<Values>) => void;
+    resetValues: () => void;
+    setValuesSnapshot: (payload: Values) => void;
+    initialize: (values: Values, onInitialize: () => void) => void;
+    getValues: () => Values;
+}
+export interface SetValuesSubscriberPayload<Values> {
+    path?: PropertyKey;
+    updatedValues: Values;
+    previousValues: Values;
+}
+export interface SetValuesInput<Values> {
+    values: Partial<Values> | ((values: Values) => Partial<Values>);
+    mergeWithPreviousValues?: boolean;
+    updateState?: boolean;
+    subscribers?: (SetFieldValueSubscriber<Values> | null | undefined)[];
+}
+export type SetFieldValueSubscriber<Values> = (payload: SetValuesSubscriberPayload<Values>) => void;
+export interface SetFieldValueInput<Values> {
+    path: PropertyKey;
+    value: any;
+    updateState?: boolean;
+    subscribers?: (SetFieldValueSubscriber<Values> | null | undefined)[];
+}
+interface UseFormValuesInput<Values extends Record<PropertyKey, any>> {
+    initialValues: Values | undefined;
+    mode: FormMode;
+    onValuesChange?: ((values: Values, previousValues: Values) => void) | undefined;
+}
+export declare function useFormValues<Values extends Record<PropertyKey, any>>({ initialValues, onValuesChange, mode, }: UseFormValuesInput<Values>): $FormValues<Values>;
+export {};

package/lib/hooks/use-form-watch/use-form-watch.d.ts

@@ -0,0 +1,12 @@
+import { FormFieldSubscriber, LooseKeys, Watch } from '../../types';
+import { $FormStatus } from '../use-form-status/use-form-status';
+import { SetValuesSubscriberPayload } from '../use-form-values/use-form-values';
+interface UseFormWatchInput<Values extends Record<string, any>> {
+    $status: $FormStatus<Values>;
+}
+export declare function useFormWatch<Values extends Record<string, any>>({ $status, }: UseFormWatchInput<Values>): {
+    subscribers: import("react").MutableRefObject<Record<LooseKeys<Values>, FormFieldSubscriber<Values, any>[]>>;
+    watch: Watch<Values>;
+    getFieldSubscribers: (path: LooseKeys<Values>) => ((input: SetValuesSubscriberPayload<Values>) => void)[];
+};
+export {};

package/lib/types.d.ts

@@ -1,4 +1,5 @@
 export type GetInputPropsType = 'input' | 'checkbox';
+export type FormMode = 'controlled' | 'uncontrolled';
 export type FormStatus = Record<string, boolean>;
 export interface FormFieldValidationResult {
     hasError: boolean;
@@ -45,7 +46,9 @@ export interface GetInputPropsReturnType {
 }
 export type GetInputProps<Values> = <Field extends LooseKeys<Values>>(path: Field, options?: GetInputPropsOptions) => GetInputPropsReturnType;
 export type PathValue<T, P extends LooseKeys<T>> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? PathValue<T[K], Rest> : unknown : P extends keyof T ? T[P] : unknown;
-export type SetFieldValue<Values> = <Field extends LooseKeys<Values>>(path: Field, value: PathValue<Values, Field> | ((prevValue: PathValue<Values, Field>) => PathValue<Values, Field>)) => void;
+export type SetFieldValue<Values> = <Field extends LooseKeys<Values>>(path: Field, value: PathValue<Values, Field> | ((prevValue: PathValue<Values, Field>) => PathValue<Values, Field>), options?: {
+    forceUpdate: boolean;
+}) => void;
 export type ClearFieldError = (path: unknown) => void;
 export type ClearFieldDirty = (path: unknown) => void;
 export type ClearErrors = () => void;
@@ -53,17 +56,28 @@ export type Reset = () => void;
 export type Validate = () => FormValidationResult;
 export type ValidateField<Values> = <Field extends LooseKeys<Values>>(path: Field) => FormFieldValidationResult;
 export type SetFieldError<Values> = <Field extends LooseKeys<Values>>(path: Field, error: React.ReactNode) => void;
+export type SetFieldTouched<Values> = <Field extends LooseKeys<Values>>(path: Field, touched: boolean) => void;
+export type SetFieldDirty<Values> = <Field extends LooseKeys<Values>>(path: Field, dirty: boolean) => void;
 export type ReorderListItem<Values> = <Field extends LooseKeys<Values>>(path: Field, payload: ReorderPayload) => void;
 export type InsertListItem<Values> = <Field extends LooseKeys<Values>>(path: Field, item: unknown, index?: number) => void;
 export type RemoveListItem<Values> = <Field extends LooseKeys<Values>>(path: Field, index: number) => void;
 export type GetFieldStatus<Values> = <Field extends LooseKeys<Values>>(path?: Field) => boolean;
 export type ResetStatus = () => void;
+export type GetStatus = () => FormStatus;
 export type ResetDirty<Values> = (values?: Values) => void;
 export type IsValid<Values> = <Field extends LooseKeys<Values>>(path?: Field) => boolean;
 export type Initialize<Values> = (values: Values) => void;
 export type _TransformValues<Values> = (values: Values) => unknown;
+export type FormFieldSubscriber<Values, Field extends LooseKeys<Values>> = (input: {
+    previousValue: PathValue<Values, Field>;
+    value: PathValue<Values, Field>;
+    touched: boolean;
+    dirty: boolean;
+}) => void;
+export type Watch<Values> = <Field extends LooseKeys<Values>>(path: Field, subscriber: FormFieldSubscriber<Values, Field>) => void;
 export interface UseFormInput<Values, TransformValues extends _TransformValues<Values> = (values: Values) => Values> {
     name?: string;
+    mode?: FormMode;
     initialValues?: Values;
     initialErrors?: FormErrors;
     initialTouched?: FormStatus;
@@ -110,6 +124,10 @@ export interface UseFormReturnType<Values, TransformValues extends _TransformVal
     resetDirty: ResetDirty<Values>;
     isValid: IsValid<Values>;
     getTransformedValues: GetTransformedValues<Values, TransformValues>;
+    getValues: () => Values;
+    getTouched: GetStatus;
+    getDirty: GetStatus;
+    watch: Watch<Values>;
 }
 export type UseForm<Values = Record<string, unknown>, TransformValues extends _TransformValues<Values> = (values: Values) => Values> = (input?: UseFormInput<Values, TransformValues>) => UseFormReturnType<Values, TransformValues>;
 export type TransformedValues<Form extends UseFormReturnType<any>> = Parameters<Parameters<Form['onSubmit']>[0]>[0];

package/lib/use-form.d.ts

@@ -1,2 +1,2 @@
 import { _TransformValues, UseFormInput, UseFormReturnType } from './types';
-export declare function useForm<Values = Record<string, unknown>, TransformValues extends _TransformValues<Values> = (values: Values) => Values>({ name, initialValues, initialErrors, initialDirty, initialTouched, clearInputErrorOnChange, validateInputOnChange, validateInputOnBlur, onValuesChange, transformValues, enhanceGetInputProps, validate: rules, }?: UseFormInput<Values, TransformValues>): UseFormReturnType<Values, TransformValues>;
+export declare function useForm<Values extends Record<string, any> = Record<string, any>, TransformValues extends _TransformValues<Values> = (values: Values) => Values>({ name, mode, initialValues, initialErrors, initialDirty, initialTouched, clearInputErrorOnChange, validateInputOnChange, validateInputOnBlur, onValuesChange, transformValues, enhanceGetInputProps, validate: rules, }?: UseFormInput<Values, TransformValues>): UseFormReturnType<Values, TransformValues>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mantine/form",
-  "version": "7.7.2",
+  "version": "7.8.0",
   "description": "Mantine form management library",
   "homepage": "https://mantine.dev",
   "license": "MIT",

package/cjs/filter-errors/filter-errors.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"filter-errors.cjs","sources":["../../src/filter-errors/filter-errors.ts"],"sourcesContent":["import type { FormErrors } from '../types';\n\nexport function filterErrors(errors: FormErrors): FormErrors {\n  if (errors === null || typeof errors !== 'object') {\n    return {};\n  }\n\n  return Object.keys(errors).reduce<FormErrors>((acc, key) => {\n    const errorValue = errors[key];\n\n    if (errorValue !== undefined && errorValue !== null && errorValue !== false) {\n      acc[key] = errorValue;\n    }\n\n    return acc;\n  }, {});\n}\n"],"names":[],"mappings":";;;AACO,CAAS,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAY,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAE,CAAA,CAAA;AACrC,CAAE,CAAA,CAAA,CAAA,CAAA,CAAI,MAAM,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAI,IAAI,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAE,CAAA,CAAA;AACrD,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAO,EAAE,CAAC;AACd,CAAG,CAAA,CAAA;AACH,CAAA,CAAE,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAC,CAAA,CAAA,CAAA,CAAI,CAAC,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAC,CAAC,CAAG,CAAA,CAAA,CAAA,CAAE,GAAG,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA;AAClD,CAAA,CAAA,CAAA,CAAI,MAAM,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAG,MAAM,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;AACnC,CAAA,CAAA,CAAA,CAAI,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAU,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,CAAC,CAAA,CAAA,CAAA,CAAI,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAI,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,KAAK,CAAE,CAAA,CAAA;AAC9E,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,GAAG,CAAC,CAAA,CAAA,CAAG,CAAC,CAAA,CAAA,CAAG,UAAU,CAAC;AAC5B,CAAK,CAAA,CAAA,CAAA,CAAA;AACL,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAO,GAAG,CAAC;AACf,CAAG,CAAA,CAAA,CAAA,CAAE,CAAE,CAAA,CAAC,CAAC;AACT,CAAA;;"}

package/esm/filter-errors/filter-errors.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"filter-errors.mjs","sources":["../../src/filter-errors/filter-errors.ts"],"sourcesContent":["import type { FormErrors } from '../types';\n\nexport function filterErrors(errors: FormErrors): FormErrors {\n  if (errors === null || typeof errors !== 'object') {\n    return {};\n  }\n\n  return Object.keys(errors).reduce<FormErrors>((acc, key) => {\n    const errorValue = errors[key];\n\n    if (errorValue !== undefined && errorValue !== null && errorValue !== false) {\n      acc[key] = errorValue;\n    }\n\n    return acc;\n  }, {});\n}\n"],"names":[],"mappings":";AACO,CAAS,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAY,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAE,CAAA,CAAA;AACrC,CAAE,CAAA,CAAA,CAAA,CAAA,CAAI,MAAM,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAI,IAAI,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAE,CAAA,CAAA;AACrD,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAO,EAAE,CAAC;AACd,CAAG,CAAA,CAAA;AACH,CAAA,CAAE,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAC,CAAA,CAAA,CAAA,CAAI,CAAC,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAC,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAC,CAAC,CAAG,CAAA,CAAA,CAAA,CAAE,GAAG,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA;AAClD,CAAA,CAAA,CAAA,CAAI,MAAM,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAG,MAAM,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;AACnC,CAAA,CAAA,CAAA,CAAI,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAU,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,CAAC,CAAA,CAAA,CAAA,CAAI,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAI,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAK,KAAK,CAAE,CAAA,CAAA;AAC9E,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,GAAG,CAAC,CAAA,CAAA,CAAG,CAAC,CAAA,CAAA,CAAG,UAAU,CAAC;AAC5B,CAAK,CAAA,CAAA,CAAA,CAAA;AACL,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAO,GAAG,CAAC;AACf,CAAG,CAAA,CAAA,CAAA,CAAE,CAAE,CAAA,CAAC,CAAC;AACT,CAAA;;"}

package/lib/filter-errors/index.d.ts

@@ -1 +0,0 @@
-export { filterErrors } from './filter-errors';