form.tsx 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. "use client";
  2. import * as React from "react";
  3. import * as LabelPrimitive from "@radix-ui/react-label";
  4. import { Slot } from "@radix-ui/react-slot";
  5. import {
  6. Controller,
  7. FormProvider,
  8. useFormContext,
  9. useFormState,
  10. type ControllerProps,
  11. type FieldPath,
  12. type FieldValues,
  13. } from "react-hook-form";
  14. import { cn } from "@/lib/utils";
  15. import { Label } from "@/components/ui/label";
  16. const Form = FormProvider;
  17. type FormFieldContextValue<
  18. TFieldValues extends FieldValues = FieldValues,
  19. TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
  20. > = {
  21. name: TName;
  22. };
  23. const FormFieldContext = React.createContext<FormFieldContextValue>(
  24. {} as FormFieldContextValue
  25. );
  26. const FormField = <
  27. TFieldValues extends FieldValues = FieldValues,
  28. TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
  29. >({
  30. ...props
  31. }: ControllerProps<TFieldValues, TName>) => {
  32. return (
  33. <FormFieldContext.Provider value={{ name: props.name }}>
  34. <Controller {...props} />
  35. </FormFieldContext.Provider>
  36. );
  37. };
  38. const useFormField = () => {
  39. const fieldContext = React.useContext(FormFieldContext);
  40. const itemContext = React.useContext(FormItemContext);
  41. const { getFieldState } = useFormContext();
  42. const formState = useFormState({ name: fieldContext.name });
  43. const fieldState = getFieldState(fieldContext.name, formState);
  44. if (!fieldContext) {
  45. throw new Error("useFormField should be used within <FormField>");
  46. }
  47. const { id } = itemContext;
  48. return {
  49. id,
  50. name: fieldContext.name,
  51. formItemId: `${id}-form-item`,
  52. formDescriptionId: `${id}-form-item-description`,
  53. formMessageId: `${id}-form-item-message`,
  54. ...fieldState,
  55. };
  56. };
  57. type FormItemContextValue = {
  58. id: string;
  59. };
  60. const FormItemContext = React.createContext<FormItemContextValue>(
  61. {} as FormItemContextValue
  62. );
  63. function FormItem({ className, ...props }: React.ComponentProps<"div">) {
  64. const id = React.useId();
  65. return (
  66. <FormItemContext.Provider value={{ id }}>
  67. <div
  68. data-slot="form-item"
  69. className={cn("grid gap-2", className)}
  70. {...props}
  71. />
  72. </FormItemContext.Provider>
  73. );
  74. }
  75. function FormLabel({
  76. className,
  77. ...props
  78. }: React.ComponentProps<typeof LabelPrimitive.Root>) {
  79. const { error, formItemId } = useFormField();
  80. return (
  81. <Label
  82. data-slot="form-label"
  83. data-error={!!error}
  84. className={cn("data-[error=true]:text-destructive", className)}
  85. htmlFor={formItemId}
  86. {...props}
  87. />
  88. );
  89. }
  90. function FormControl({ ...props }: React.ComponentProps<typeof Slot>) {
  91. const { error, formItemId, formDescriptionId, formMessageId } =
  92. useFormField();
  93. return (
  94. <Slot
  95. data-slot="form-control"
  96. id={formItemId}
  97. aria-describedby={
  98. !error
  99. ? `${formDescriptionId}`
  100. : `${formDescriptionId} ${formMessageId}`
  101. }
  102. aria-invalid={!!error}
  103. {...props}
  104. />
  105. );
  106. }
  107. function FormDescription({ className, ...props }: React.ComponentProps<"p">) {
  108. const { formDescriptionId } = useFormField();
  109. return (
  110. <p
  111. data-slot="form-description"
  112. id={formDescriptionId}
  113. className={cn("text-muted-foreground text-sm", className)}
  114. {...props}
  115. />
  116. );
  117. }
  118. function FormMessage({ className, ...props }: React.ComponentProps<"p">) {
  119. const { error, formMessageId } = useFormField();
  120. const body = error ? String(error?.message ?? "") : props.children;
  121. if (!body) {
  122. return null;
  123. }
  124. return (
  125. <p
  126. data-slot="form-message"
  127. id={formMessageId}
  128. className={cn("text-destructive text-sm", className)}
  129. {...props}
  130. >
  131. {body}
  132. </p>
  133. );
  134. }
  135. export {
  136. useFormField,
  137. Form,
  138. FormItem,
  139. FormLabel,
  140. FormControl,
  141. FormDescription,
  142. FormMessage,
  143. FormField,
  144. };