@rachelallyson/hero-hook-form 1.0.1 → 1.1.0

package/dist/react/index.d.ts

@@ -2,6 +2,7 @@ import React$1, { ComponentProps } from 'react';
 import { Input, Textarea, Select, Checkbox, Switch, RadioGroup, Button, DateInput, Slider } from '@heroui/react';
 import * as react_hook_form from 'react-hook-form';
 import { FieldValues, Path, RegisterOptions, Control, UseFormReturn, FieldErrors, UseFormProps, SubmitHandler, UseFormSetError } from 'react-hook-form';
+export { UseFormReturn, useFormContext } from 'react-hook-form';
 import * as zod from 'zod';
 import { z } from 'zod';
 import * as _internationalized_date from '@internationalized/date';
@@ -79,6 +80,11 @@ interface FileFieldConfig<TFieldValues extends FieldValues> extends BaseFormFiel
     multiple?: boolean;
     accept?: string;
 }
+interface FontPickerFieldConfig<TFieldValues extends FieldValues> extends BaseFormFieldConfig<TFieldValues> {
+    type: "fontPicker";
+    defaultValue?: string;
+    fontPickerProps?: Record<string, string | number | boolean>;
+}
 interface CustomFieldConfig<TFieldValues extends FieldValues> extends BaseFormFieldConfig<TFieldValues> {
     type: "custom";
     render: (field: {
@@ -89,7 +95,7 @@ interface CustomFieldConfig<TFieldValues extends FieldValues> extends BaseFormFi
         isSubmitting: boolean;
     }) => React.ReactNode;
 }
-type FormFieldConfig<TFieldValues extends FieldValues> = StringFieldConfig<TFieldValues> | BooleanFieldConfig<TFieldValues> | RadioFieldConfig<TFieldValues> | SliderFieldConfig<TFieldValues> | DateFieldConfig<TFieldValues> | FileFieldConfig<TFieldValues> | CustomFieldConfig<TFieldValues>;
+type FormFieldConfig<TFieldValues extends FieldValues> = StringFieldConfig<TFieldValues> | BooleanFieldConfig<TFieldValues> | RadioFieldConfig<TFieldValues> | SliderFieldConfig<TFieldValues> | DateFieldConfig<TFieldValues> | FileFieldConfig<TFieldValues> | FontPickerFieldConfig<TFieldValues> | CustomFieldConfig<TFieldValues>;
 interface FormConfig<TFieldValues extends FieldValues> {
     fields: FormFieldConfig<TFieldValues>[];
     layout?: "vertical" | "horizontal" | "grid" | "custom";
@@ -103,9 +109,9 @@ interface FormConfig<TFieldValues extends FieldValues> {
     className?: string;
     defaultValues?: Partial<TFieldValues>;
 }
-type ZodFormFieldConfig<TFieldValues extends FieldValues> = Omit<StringFieldConfig<TFieldValues>, "rules"> | Omit<BooleanFieldConfig<TFieldValues>, "rules"> | Omit<RadioFieldConfig<TFieldValues>, "rules"> | Omit<SliderFieldConfig<TFieldValues>, "rules"> | Omit<DateFieldConfig<TFieldValues>, "rules"> | Omit<FileFieldConfig<TFieldValues>, "rules">;
+type ZodFormFieldConfig<TFieldValues extends FieldValues> = Omit<StringFieldConfig<TFieldValues>, "rules"> | Omit<BooleanFieldConfig<TFieldValues>, "rules"> | Omit<RadioFieldConfig<TFieldValues>, "rules"> | Omit<SliderFieldConfig<TFieldValues>, "rules"> | Omit<DateFieldConfig<TFieldValues>, "rules"> | Omit<FileFieldConfig<TFieldValues>, "rules"> | Omit<FontPickerFieldConfig<TFieldValues>, "rules">;
 interface ZodFormConfig<TFieldValues extends FieldValues> extends UseFormProps<TFieldValues> {
-    schema?: zod.ZodSchema<TFieldValues>;
+    schema: zod.ZodSchema<TFieldValues>;
     fields: ZodFormFieldConfig<TFieldValues>[];
     onError?: (errors: FieldErrors<TFieldValues>) => void;
     errorDisplay?: "inline" | "toast" | "modal" | "none";
@@ -227,6 +233,17 @@ type FileFieldProps<TFieldValues extends FieldValues> = FieldBaseProps<TFieldVal
 };
 declare function FileField<TFieldValues extends FieldValues>(props: FileFieldProps<TFieldValues>): React$1.JSX.Element;
 
+interface FontPickerProps {
+    showFontPreview?: boolean;
+    loadAllVariants?: boolean;
+    onFontsLoaded?: (loaded: boolean) => void;
+    fontsLoadedTimeout?: number;
+}
+type FontPickerFieldProps<TFieldValues extends FieldValues, TValue extends string = string> = FieldBaseProps<TFieldValues, TValue> & WithControl<TFieldValues> & {
+    fontPickerProps?: FontPickerProps;
+};
+declare function FontPickerField<TFieldValues extends FieldValues, TValue extends string = string>(props: FontPickerFieldProps<TFieldValues, TValue>): React$1.JSX.Element;
+
 type InputFieldProps<TFieldValues extends FieldValues> = FieldBaseProps<TFieldValues, string> & WithControl<TFieldValues> & {
     inputProps?: Omit<React$1.ComponentProps<typeof Input>, "value" | "onValueChange" | "label" | "isInvalid" | "errorMessage" | "isDisabled">;
     transform?: (value: string) => string;
@@ -292,6 +309,54 @@ declare function useFormHelper<T extends FieldValues>({ defaultValues, methods,
     submissionState: FormSubmissionState;
 };
 
+/**
+ * Enhanced hook that provides both form methods and styling defaults
+ *
+ * This hook combines React Hook Form's useFormContext with Hero Hook Form's
+ * styling defaults, giving you access to both form functionality and
+ * component styling in one convenient hook.
+ *
+ * @example
+ * ```tsx
+ * import { useHeroForm } from "@rachelallyson/hero-hook-form";
+ *
+ * function MyComponent() {
+ *   const { formState, getValues, setValue, defaults } = useHeroForm();
+ *
+ *   // Access form state
+ *   const isSubmitting = formState.isSubmitting;
+ *   const errors = formState.errors;
+ *
+ *   // Access form methods
+ *   const values = getValues();
+ *   const handleReset = () => setValue('fieldName', '');
+ *
+ *   // Access styling defaults
+ *   const inputDefaults = defaults.input;
+ *   const buttonDefaults = defaults.submitButton;
+ * }
+ * ```
+ */
+declare function useHeroForm<TFieldValues extends FieldValues>(): {
+    defaults: Required<Pick<HeroHookFormDefaultsConfig, "input" | "textarea" | "select" | "switch" | "radioGroup" | "checkbox" | "slider" | "dateInput" | "submitButton">>;
+    watch: react_hook_form.UseFormWatch<TFieldValues>;
+    getValues: react_hook_form.UseFormGetValues<TFieldValues>;
+    getFieldState: react_hook_form.UseFormGetFieldState<TFieldValues>;
+    setError: react_hook_form.UseFormSetError<TFieldValues>;
+    clearErrors: react_hook_form.UseFormClearErrors<TFieldValues>;
+    setValue: react_hook_form.UseFormSetValue<TFieldValues>;
+    trigger: react_hook_form.UseFormTrigger<TFieldValues>;
+    formState: react_hook_form.FormState<TFieldValues>;
+    resetField: react_hook_form.UseFormResetField<TFieldValues>;
+    reset: react_hook_form.UseFormReset<TFieldValues>;
+    handleSubmit: react_hook_form.UseFormHandleSubmit<TFieldValues, TFieldValues>;
+    unregister: react_hook_form.UseFormUnregister<TFieldValues>;
+    control: react_hook_form.Control<TFieldValues, any, TFieldValues>;
+    register: react_hook_form.UseFormRegister<TFieldValues>;
+    setFocus: react_hook_form.UseFormSetFocus<TFieldValues>;
+    subscribe: react_hook_form.UseFormSubscribe<TFieldValues>;
+};
+
 type InputProps = React$1.ComponentProps<typeof Input>;
 type TextareaProps = React$1.ComponentProps<typeof Textarea>;
 type SelectProps = React$1.ComponentProps<typeof Select>;
@@ -524,5 +589,9 @@ declare function ZodForm<T extends FieldValues>({ className, columns, config, er
  * Hook for using Zod validation with React Hook Form
  */
 declare function useZodForm<TFieldValues extends FieldValues>(config: ZodFormConfig<TFieldValues>): react_hook_form.UseFormReturn<TFieldValues, any, TFieldValues>;
+/**
+ * Helper function to create Zod form configurations
+ */
+declare function createZodFormConfig<TFieldValues extends FieldValues>(schema: z.ZodSchema<TFieldValues>, fields: ZodFormFieldConfig<TFieldValues>[], defaultValues?: Partial<TFieldValues>): ZodFormConfig<TFieldValues>;
 
-export { type BaseFormFieldConfig, type BooleanFieldConfig, type ButtonDefaults, type CheckboxDefaults, CheckboxField, type CheckboxFieldProps, type CommonFieldDefaults, type ConditionalValidation, ConfigurableForm, type CustomFieldConfig, DateField, type DateFieldConfig, type DateFieldProps, type DateInputDefaults, type FieldBaseProps, type FieldGroup, FileField, type FileFieldConfig, type FileFieldProps, type FormConfig, FormField, type FormFieldConfig, type FormProps, FormProvider, type FormStep, type FormSubmissionState, type FormTestUtils, type FormValidationError, type HeroHookFormDefaultsConfig, HeroHookFormProvider, type HeroHookFormProviderProps, type InputDefaults, InputField, type InputFieldProps, type RadioFieldConfig, type RadioGroupDefaults, RadioGroupField, type RadioGroupFieldProps, type SelectDefaults, SelectField, type SelectFieldProps, type ServerFieldError, type ServerFormError, type SliderDefaults, SliderField, type SliderFieldConfig, type SliderFieldProps, type StringFieldConfig, SubmitButton, type SubmitButtonProps, type SwitchDefaults, SwitchField, type SwitchFieldProps, type TextareaDefaults, TextareaField, type TextareaFieldProps, type ValidationUtils, type WithControl, type WizardFormConfig, ZodForm, type ZodFormConfig, type ZodFormFieldConfig, applyServerErrors, commonValidations, createConditionalSchema, createConfirmPasswordSchema, createDateSchema, createEmailSchema, createFileSchema, createFormTestUtils, createFutureDateSchema, createMaxLengthSchema, createMinLengthSchema, createMockFormData, createMockFormErrors, createNumberRangeSchema, createPasswordSchema, createPastDateSchema, createPhoneSchema, createRequiredCheckboxSchema, createRequiredSchema, createUrlSchema, getFieldError, getFormErrors, hasFieldError, hasFormErrors, simulateFieldInput, simulateFormSubmission, useFormHelper, useHeroHookFormDefaults, useZodForm, waitForFormState };
+export { type BaseFormFieldConfig, type BooleanFieldConfig, type ButtonDefaults, type CheckboxDefaults, CheckboxField, type CheckboxFieldProps, type CommonFieldDefaults, type ConditionalValidation, ConfigurableForm, type CustomFieldConfig, DateField, type DateFieldConfig, type DateFieldProps, type DateInputDefaults, type FieldBaseProps, type FieldGroup, FileField, type FileFieldConfig, type FileFieldProps, FontPickerField, type FontPickerFieldConfig, type FontPickerFieldProps, type FormConfig, FormField, type FormFieldConfig, type FormProps, FormProvider, type FormStep, type FormSubmissionState, type FormTestUtils, type FormValidationError, type HeroHookFormDefaultsConfig, HeroHookFormProvider, type HeroHookFormProviderProps, type InputDefaults, InputField, type InputFieldProps, type RadioFieldConfig, type RadioGroupDefaults, RadioGroupField, type RadioGroupFieldProps, type SelectDefaults, SelectField, type SelectFieldProps, type ServerFieldError, type ServerFormError, type SliderDefaults, SliderField, type SliderFieldConfig, type SliderFieldProps, type StringFieldConfig, SubmitButton, type SubmitButtonProps, type SwitchDefaults, SwitchField, type SwitchFieldProps, type TextareaDefaults, TextareaField, type TextareaFieldProps, type ValidationUtils, type WithControl, type WizardFormConfig, ZodForm, type ZodFormConfig, type ZodFormFieldConfig, applyServerErrors, commonValidations, createConditionalSchema, createConfirmPasswordSchema, createDateSchema, createEmailSchema, createFileSchema, createFormTestUtils, createFutureDateSchema, createMaxLengthSchema, createMinLengthSchema, createMockFormData, createMockFormErrors, createNumberRangeSchema, createPasswordSchema, createPastDateSchema, createPhoneSchema, createRequiredCheckboxSchema, createRequiredSchema, createUrlSchema, createZodFormConfig, getFieldError, getFormErrors, hasFieldError, hasFormErrors, simulateFieldInput, simulateFormSubmission, useFormHelper, useHeroForm, useHeroHookFormDefaults, useZodForm, waitForFormState };