Field

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add field

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update field

Preview

import {
  Field,
  FieldDescription,
  FieldLabel,
} from "@registry/components/ui/field"

Usage

Wrap FieldLabel, a control, FieldDescription and FieldError in Field.

Field connects validation state and accessible descriptions. FieldControl exposes the underlying control integration; FieldValidity provides render access to validation results. FieldItem lays out a control and its label.

Import from the local file installed by the CLI.

"use client"

import {
  Field,
  FieldDescription,
  FieldLabel,
} from "@/components/ui/field"
import { Input } from "@/components/ui/input"

export function Preview() {
  return (
    <Field name="name">
      <FieldLabel>Name</FieldLabel>
      <Input autoComplete="name" />
      <FieldDescription>Shown on your profile.</FieldDescription>
    </Field>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.