Files
portabase/src/components/ui/form.tsx
T

230 lines
5.6 KiB
TypeScript
Raw Normal View History

2024-11-03 21:12:40 +01:00
import {cn} from "@/lib/utils";
import {zodResolver} from "@hookform/resolvers/zod";
import type * as LabelPrimitive from "@radix-ui/react-label";
import {Slot} from "@radix-ui/react-slot";
import * as React from "react";
import type {
2024-10-19 15:55:51 +02:00
ControllerProps,
FieldPath,
FieldValues,
2024-11-03 21:12:40 +01:00
SubmitHandler,
UseFormProps,
UseFormReturn,
} from "react-hook-form";
import {
Controller,
2024-10-19 15:55:51 +02:00
FormProvider,
2024-11-03 21:12:40 +01:00
useForm,
2024-10-19 15:55:51 +02:00
useFormContext,
2024-11-03 21:12:40 +01:00
} from "react-hook-form";
import type {TypeOf, ZodSchema} from "zod";
import {Label} from "./label";
2024-10-19 15:55:51 +02:00
2024-11-03 21:12:40 +01:00
type FormProps<T extends FieldValues> = Omit<
React.ComponentProps<"form">,
"onSubmit"
> & {
form: UseFormReturn<T>;
onSubmit: SubmitHandler<T>;
disabled?: boolean;
};
2024-10-19 15:55:51 +02:00
2024-11-03 21:12:40 +01:00
const Form = <T extends FieldValues>({
form,
onSubmit,
children,
className,
disabled,
...props
}: FormProps<T>) => (
<FormProvider {...form}>
<form
onSubmit={form.handleSubmit(onSubmit)}
{...props}
className={className}
>
<fieldset
disabled={disabled || form.formState.isSubmitting}
className={className}
>
{children}
</fieldset>
</form>
</FormProvider>
);
2024-10-19 15:55:51 +02:00
type FormFieldContextValue<
2024-11-03 21:12:40 +01:00
TFieldValues extends FieldValues = FieldValues,
TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>
2024-10-19 15:55:51 +02:00
> = {
2024-11-03 21:12:40 +01:00
name: TName;
};
2024-10-19 15:55:51 +02:00
const FormFieldContext = React.createContext<FormFieldContextValue>(
2024-11-03 21:12:40 +01:00
{} as FormFieldContextValue
);
2024-10-19 15:55:51 +02:00
const FormField = <
2024-11-03 21:12:40 +01:00
TFieldValues extends FieldValues = FieldValues,
TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>
2024-10-19 15:55:51 +02:00
>({
2024-11-03 21:12:40 +01:00
...props
}: ControllerProps<TFieldValues, TName>) => {
2024-10-19 15:55:51 +02:00
return (
2024-11-03 21:12:40 +01:00
<FormFieldContext.Provider value={{name: props.name}}>
<Controller {...props} />
</FormFieldContext.Provider>
);
};
2024-10-19 15:55:51 +02:00
const useFormField = () => {
2024-11-03 21:12:40 +01:00
const fieldContext = React.useContext(FormFieldContext);
const itemContext = React.useContext(FormItemContext);
const {getFieldState, formState} = useFormContext();
2024-10-19 15:55:51 +02:00
2024-11-03 21:12:40 +01:00
const fieldState = getFieldState(fieldContext.name, formState);
2024-10-19 15:55:51 +02:00
2024-11-03 21:12:40 +01:00
if (!fieldContext.name) {
throw new Error("useFormField should be used within <FormField>");
2024-10-19 15:55:51 +02:00
}
2024-11-03 21:12:40 +01:00
const {id} = itemContext;
2024-10-19 15:55:51 +02:00
return {
id,
name: fieldContext.name,
formItemId: `${id}-form-item`,
formDescriptionId: `${id}-form-item-description`,
formMessageId: `${id}-form-item-message`,
...fieldState,
2024-11-03 21:12:40 +01:00
};
};
2024-10-19 15:55:51 +02:00
type FormItemContextValue = {
2024-11-03 21:12:40 +01:00
id: string;
};
2024-10-19 15:55:51 +02:00
const FormItemContext = React.createContext<FormItemContextValue>(
2024-11-03 21:12:40 +01:00
{} as FormItemContextValue
);
2024-10-19 15:55:51 +02:00
const FormItem = React.forwardRef<
2024-11-03 21:12:40 +01:00
HTMLDivElement,
React.HTMLAttributes<HTMLDivElement>
>(({className, ...props}, ref) => {
const id = React.useId();
2024-10-19 15:55:51 +02:00
return (
2024-11-03 21:12:40 +01:00
<FormItemContext.Provider value={{id}}>
<div ref={ref} className={cn("space-y-2", className)} {...props} />
</FormItemContext.Provider>
);
});
FormItem.displayName = "FormItem";
2024-10-19 15:55:51 +02:00
const FormLabel = React.forwardRef<
2024-11-03 21:12:40 +01:00
React.ElementRef<typeof LabelPrimitive.Root>,
React.ComponentPropsWithoutRef<typeof LabelPrimitive.Root>
>(({className, ...props}, ref) => {
const {error, formItemId} = useFormField();
2024-10-19 15:55:51 +02:00
return (
2024-11-03 21:12:40 +01:00
<Label
ref={ref}
className={cn(error && "text-destructive", className)}
htmlFor={formItemId}
{...props}
/>
);
});
FormLabel.displayName = "FormLabel";
2024-10-19 15:55:51 +02:00
const FormControl = React.forwardRef<
2024-11-03 21:12:40 +01:00
React.ElementRef<typeof Slot>,
React.ComponentPropsWithoutRef<typeof Slot>
>(({...props}, ref) => {
const {error, formItemId, formDescriptionId, formMessageId} =
useFormField();
2024-10-19 15:55:51 +02:00
return (
2024-11-03 21:12:40 +01:00
<Slot
ref={ref}
id={formItemId}
aria-describedby={
error ? `${formDescriptionId} ${formMessageId}` : `${formDescriptionId}`
}
aria-invalid={!!error}
{...props}
/>
);
});
FormControl.displayName = "FormControl";
2024-10-19 15:55:51 +02:00
const FormDescription = React.forwardRef<
2024-11-03 21:12:40 +01:00
HTMLParagraphElement,
React.HTMLAttributes<HTMLParagraphElement>
>(({className, ...props}, ref) => {
const {formDescriptionId} = useFormField();
2024-10-19 15:55:51 +02:00
return (
2024-11-03 21:12:40 +01:00
<p
ref={ref}
id={formDescriptionId}
className={cn("text-sm text-muted-foreground", className)}
{...props}
/>
);
});
FormDescription.displayName = "FormDescription";
2024-10-19 15:55:51 +02:00
const FormMessage = React.forwardRef<
2024-11-03 21:12:40 +01:00
HTMLParagraphElement,
React.HTMLAttributes<HTMLParagraphElement>
>(({className, children, ...props}, ref) => {
const {error, formMessageId} = useFormField();
const body = error ? String(error.message) : children;
2024-10-19 15:55:51 +02:00
if (!body) {
2024-11-03 21:12:40 +01:00
return null;
2024-10-19 15:55:51 +02:00
}
return (
2024-11-03 21:12:40 +01:00
<p
ref={ref}
id={formMessageId}
className={cn("text-sm font-medium text-destructive", className)}
{...props}
>
{body}
</p>
);
});
FormMessage.displayName = "FormMessage";
type UseZodFormProps<Z extends ZodSchema> = Exclude<
UseFormProps<TypeOf<Z>>,
"resolver"
> & {
schema: Z;
};
const useZodForm = <Z extends ZodSchema>({
schema,
...formProps
}: UseZodFormProps<Z>) =>
useForm({
...formProps,
resolver: zodResolver(schema),
});
2024-10-19 15:55:51 +02:00
export {
Form,
FormControl,
FormDescription,
FormField,
2024-11-03 21:12:40 +01:00
FormItem,
FormLabel,
FormMessage,
useFormField,
useZodForm,
};