FormField

Usage

import { FormField, Input } from "@devvy-ui/react";

<FormField label="Workspace email" description="Used for project updates." required>{field => <Input {...field} name="email" type="email" />}</FormField>

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
label / children	ReactNode / render function	required	Visible label and a control receiving FieldControlProps.
description / error	ReactNode	—	Connected help and validation message.
required / controlId	boolean / string	false / generated ID	Native required and optional explicit control ID.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add form-field

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

FormField.tsxREACT / TSX

import { forwardRef, useId, type HTMLAttributes, type ReactNode } from 'react';
import { cx } from '../lib/cx';
export interface FieldControlProps {
  id: string;
  'aria-describedby'?: string;
  'aria-invalid'?: true;
  required?: boolean;
}
export interface FormFieldProps extends Omit<HTMLAttributes<HTMLDivElement>, 'children'> {
  label: ReactNode;
  description?: ReactNode;
  error?: ReactNode;
  required?: boolean;
  controlId?: string;
  children: (props: FieldControlProps) => ReactNode;
}
export const FormField = forwardRef<HTMLDivElement, FormFieldProps>(function FormField(
  { label, description, error, required, controlId, children, className, ...props },
  ref,
) {
  const generated = useId();
  const id = controlId ?? generated + '-control';
  const describedBy =
    [description ? id + '-help' : '', error ? id + '-error' : ''].filter(Boolean).join(' ') ||
    undefined;
  return (
    <div {...props} ref={ref} className={cx('dvy-form-field', className)} data-invalid={!!error}>
      <label htmlFor={id}>
        {label}
        {required && <span aria-hidden="true"> *</span>}
      </label>
      {description && (
        <p id={id + '-help'} className="dvy-field-description">
          {description}
        </p>
      )}
      {children({
        id,
        'aria-describedby': describedBy,
        'aria-invalid': error ? true : undefined,
        required,
      })}
      {error && (
        <p id={id + '-error'} className="dvy-field-error">
          {error}
        </p>
      )}
    </div>
  );
});

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.