-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: form related components and examples
- Loading branch information
1 parent
9b526c6
commit c85e8c8
Showing
10 changed files
with
427 additions
and
6 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| "use client"; | ||
|
|
||
| import * as CollapsiblePrimitive from "@radix-ui/react-collapsible"; | ||
| import { cn } from "lib/cssUtils"; | ||
| import { | ||
| type ComponentPropsWithoutRef, | ||
| type ElementRef, | ||
| forwardRef, | ||
| } from "react"; | ||
|
|
||
| const Collapsible = CollapsiblePrimitive.Root; | ||
|
|
||
| const CollapsibleTrigger = CollapsiblePrimitive.CollapsibleTrigger; | ||
|
|
||
| const CollapsibleContent = forwardRef< | ||
| ElementRef<typeof CollapsiblePrimitive.CollapsibleContent>, | ||
| ComponentPropsWithoutRef<typeof CollapsiblePrimitive.CollapsibleContent> | ||
| >(({ className, children, ...props }, ref) => ( | ||
| <CollapsiblePrimitive.CollapsibleContent | ||
| ref={ref} | ||
| className={cn( | ||
| "overflow-hidden data-[state=closed]:animate-collapse-closed data-[state=open]:animate-collapse-open", | ||
| className, | ||
| )} | ||
| {...props} | ||
| > | ||
| {children} | ||
| </CollapsiblePrimitive.CollapsibleContent> | ||
| )); | ||
|
|
||
| export { Collapsible, CollapsibleContent, CollapsibleTrigger }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| import type * as LabelPrimitive from "@radix-ui/react-label"; | ||
| import { Slot } from "@radix-ui/react-slot"; | ||
| import { useDebouncedState } from "foxact/use-debounced-state"; | ||
| import { cn } from "lib/cssUtils"; | ||
| import { | ||
| type ComponentPropsWithoutRef, | ||
| type ElementRef, | ||
| type HTMLAttributes, | ||
| createContext, | ||
| forwardRef, | ||
| useContext, | ||
| useId, | ||
| } from "react"; | ||
| import { | ||
| Controller, | ||
| type ControllerProps, | ||
| type FieldPath, | ||
| type FieldValues, | ||
| useFormContext, | ||
| } from "react-hook-form"; | ||
| import { Collapsible, CollapsibleContent } from "./Collapsible"; | ||
| import { Label } from "./Label"; | ||
|
|
||
| type FormFieldContextValue< | ||
| TFieldValues extends FieldValues = FieldValues, | ||
| TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, | ||
| > = { | ||
| name: TName; | ||
| }; | ||
|
|
||
| const FormFieldContext = createContext<FormFieldContextValue>( | ||
| {} as FormFieldContextValue, | ||
| ); | ||
|
|
||
| const FormField = < | ||
| TFieldValues extends FieldValues = FieldValues, | ||
| TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, | ||
| >({ | ||
| ...props | ||
| }: ControllerProps<TFieldValues, TName>) => ( | ||
| <FormFieldContext.Provider value={{ name: props.name }}> | ||
| <Controller {...props} /> | ||
| </FormFieldContext.Provider> | ||
| ); | ||
|
|
||
| const useFormField = () => { | ||
| const fieldContext = useContext(FormFieldContext); | ||
| const itemContext = useContext(FormItemContext); | ||
| const { getFieldState, formState } = useFormContext(); | ||
|
|
||
| const fieldState = getFieldState(fieldContext.name, formState); | ||
|
|
||
| if (!fieldContext) { | ||
| throw new Error("useFormField should be used within <FormField>"); | ||
| } | ||
|
|
||
| const { id } = itemContext; | ||
|
|
||
| return { | ||
| id, | ||
| name: fieldContext.name, | ||
| formItemId: `${id}-form-item`, | ||
| formDescriptionId: `${id}-form-item-description`, | ||
| formMessageId: `${id}-form-item-message`, | ||
| ...fieldState, | ||
| }; | ||
| }; | ||
|
|
||
| type FormItemContextValue = { | ||
| id: string; | ||
| }; | ||
|
|
||
| const FormItemContext = createContext<FormItemContextValue>( | ||
| {} as FormItemContextValue, | ||
| ); | ||
|
|
||
| const FormItem = forwardRef<HTMLDivElement, HTMLAttributes<HTMLDivElement>>( | ||
| ({ className, ...props }, ref) => { | ||
| const id = useId(); | ||
|
|
||
| return ( | ||
| <FormItemContext.Provider value={{ id }}> | ||
| <div ref={ref} className={cn("flex flex-col", className)} {...props} /> | ||
| </FormItemContext.Provider> | ||
| ); | ||
| }, | ||
| ); | ||
| FormItem.displayName = "FormItem"; | ||
|
|
||
| const FormLabel = forwardRef< | ||
| ElementRef<typeof LabelPrimitive.Root>, | ||
| ComponentPropsWithoutRef<typeof LabelPrimitive.Root> | ||
| >(({ className, children, ...props }, ref) => { | ||
| const { formItemId } = useFormField(); | ||
|
|
||
| return ( | ||
| <Label | ||
| ref={ref} | ||
| className={cn( | ||
| "group mb-2 text-md aria-disabled:text-foreground-secondary", | ||
| className, | ||
| )} | ||
| htmlFor={formItemId} | ||
| {...props} | ||
| > | ||
| {children} | ||
| <span className="ml-1 hidden select-none font-bold text-input-border-invalid group-aria-required:inline-block"> | ||
| * | ||
| </span> | ||
| </Label> | ||
| ); | ||
| }); | ||
| FormLabel.displayName = "FormLabel"; | ||
|
|
||
| const FormControl = forwardRef< | ||
| ElementRef<typeof Slot>, | ||
| ComponentPropsWithoutRef<typeof Slot> | ||
| >(({ ...props }, ref) => { | ||
| const { error, formItemId, formDescriptionId, formMessageId } = | ||
| useFormField(); | ||
|
|
||
| return ( | ||
| <Slot | ||
| ref={ref} | ||
| id={formItemId} | ||
| aria-describedby={ | ||
| !error | ||
| ? `${formDescriptionId}` | ||
| : `${formDescriptionId} ${formMessageId}` | ||
| } | ||
| aria-invalid={!!error} | ||
| {...props} | ||
| /> | ||
| ); | ||
| }); | ||
| FormControl.displayName = "FormControl"; | ||
|
|
||
| const FormDescription = forwardRef< | ||
| HTMLParagraphElement, | ||
| HTMLAttributes<HTMLParagraphElement> | ||
| >(({ className, ...props }, ref) => { | ||
| const { formDescriptionId } = useFormField(); | ||
|
|
||
| return ( | ||
| <p | ||
| ref={ref} | ||
| id={formDescriptionId} | ||
| className={cn("mt-2 text-foreground-secondary text-sm", className)} | ||
| {...props} | ||
| /> | ||
| ); | ||
| }); | ||
| FormDescription.displayName = "FormDescription"; | ||
|
|
||
| const FormErrorMessage = forwardRef< | ||
| HTMLParagraphElement, | ||
| HTMLAttributes<HTMLParagraphElement> | ||
| >(({ className, children, ...props }, ref) => { | ||
| const { error, formMessageId } = useFormField(); | ||
| const body = error ? String(error?.message) : children; | ||
| const [debouncedBody] = useDebouncedState(body, 200); | ||
|
|
||
| return ( | ||
| <Collapsible open={!!body}> | ||
| <CollapsibleContent> | ||
| <p | ||
| ref={ref} | ||
| id={formMessageId} | ||
| // TODO: not sure if it is a good idea to use "text-input-border-invalid" here? Should we add a completely new CSS variable instead? | ||
| className={cn( | ||
| "pt-2 font-medium text-input-border-invalid text-xs", | ||
| className, | ||
| )} | ||
| {...props} | ||
| > | ||
| {body ?? debouncedBody} | ||
| </p> | ||
| </CollapsibleContent> | ||
| </Collapsible> | ||
| ); | ||
| }); | ||
| FormErrorMessage.displayName = "FormErrorMessage"; | ||
|
|
||
| export { | ||
| FormControl, | ||
| FormDescription, | ||
| FormErrorMessage, | ||
| FormField, | ||
| FormItem, | ||
| FormLabel, | ||
| useFormField, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.