alouette/dist/definitions/ui/forms/FormField.d.ts

A modern, customizable design system built on top of NativeWind v5 with configurable defaults

import type { ReactNode } from "react";
import { type Control, type ControllerRenderProps, type FieldError, type FieldPath, type FieldValues, type RegisterOptions } from "react-hook-form";
export interface FormFieldProps<TFieldValues extends FieldValues, TName extends FieldPath<TFieldValues>> {
    /** From <Form>'s render params. Infers the form type for `name`. */
    control: Control<TFieldValues>;
    name: TName;
    label: string;
    /**
     * Marks the field required and shows FormItem's marker. Pass true for no
     * message, or any other ReactNode to use as the required-field error —
     * unless renderError overrides it — once the field is left empty.
     * react-hook-form's own FieldError.message is always a plain string, so
     * this is the only way to get a richer, i18n'd required message without
     * reaching for renderError.
     */
    required?: ReactNode;
    validate?: RegisterOptions<TFieldValues, TName>["validate"];
    renderError?: (error: FieldError | undefined) => ReactNode;
    render: (params: {
        field: ControllerRenderProps<TFieldValues, TName>;
        labelId: string;
    }) => ReactNode;
}
/**
 * Wires a react-hook-form Controller to FormItem's label/error/layout.
 * Must be used inside <Form>, whose render params supply `control`. Passing it
 * is what types the field: TFieldValues comes from the control and the value
 * type from `name`, so `field.value` is that one field's type rather than a
 * union of every field in the form.
 * Renders any input via `render` — not tied to a specific input component.
 * The rendered input must attach `field.ref` for pressing the label to
 * focus it, via react-hook-form's own setFocus.
 */
export declare function FormField<TFieldValues extends FieldValues, TName extends FieldPath<TFieldValues>>({ control, name, label, required, validate, renderError, render, }: FormFieldProps<TFieldValues, TName>): ReactNode;
//# sourceMappingURL=FormField.d.ts.map