ui Architecture Docs
Home / Function/ useFormField() — ui Function Reference

useFormField() — ui Function Reference

Architecture documentation for the useFormField() function in form.tsx from the ui codebase.

Function tsx ComponentRegistry ChartRegistry called by 4

Entity Profile

Dependency Diagram

graph TD
  5ef7902a_a7c8_3632_5104_bdf0a0722d94["useFormField()"]
  7c1a62f1_bcbe_4a44_ea32_9038a4216dc9["form.tsx"]
  5ef7902a_a7c8_3632_5104_bdf0a0722d94 -->|defined in| 7c1a62f1_bcbe_4a44_ea32_9038a4216dc9
  8fab3915_5f03_5bb6_ad2f_91f5c325aa56["FormLabel()"]
  8fab3915_5f03_5bb6_ad2f_91f5c325aa56 -->|calls| 5ef7902a_a7c8_3632_5104_bdf0a0722d94
  fd26655c_a254_5403_a873_ded18404ec9d["FormControl()"]
  fd26655c_a254_5403_a873_ded18404ec9d -->|calls| 5ef7902a_a7c8_3632_5104_bdf0a0722d94
  4ed70367_8220_df67_fbde_2a4b3c1a77ef["FormDescription()"]
  4ed70367_8220_df67_fbde_2a4b3c1a77ef -->|calls| 5ef7902a_a7c8_3632_5104_bdf0a0722d94
  6af91ab3_1747_a83d_1779_4786660937d9["FormMessage()"]
  6af91ab3_1747_a83d_1779_4786660937d9 -->|calls| 5ef7902a_a7c8_3632_5104_bdf0a0722d94
  style 5ef7902a_a7c8_3632_5104_bdf0a0722d94 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

deprecated/www/registry/new-york/ui/form.tsx lines 42–67

const useFormField = () => {
  const fieldContext = React.useContext(FormFieldContext)
  const itemContext = React.useContext(FormItemContext)
  const { getFieldState, formState } = useFormContext()

  if (!fieldContext) {
    throw new Error("useFormField should be used within <FormField>")
  }

  if (!itemContext) {
    throw new Error("useFormField should be used within <FormItem>")
  }

  const fieldState = getFieldState(fieldContext.name, formState)

  const { id } = itemContext

  return {
    id,
    name: fieldContext.name,
    formItemId: `${id}-form-item`,
    formDescriptionId: `${id}-form-item-description`,
    formMessageId: `${id}-form-item-message`,
    ...fieldState,
  }
}

Domain

Subdomains

Defined In

Called By

Source

Frequently Asked Questions

What does useFormField() do?
useFormField() is a function in the ui codebase, defined in deprecated/www/registry/new-york/ui/form.tsx.
Where is useFormField() defined?
useFormField() is defined in deprecated/www/registry/new-york/ui/form.tsx at line 42.
What calls useFormField()?
useFormField() is called by 4 function(s): FormControl, FormDescription, FormLabel, FormMessage.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free