ShadcnUI.Components.Forms.Field (shadcn_ui v1.0.0)

Copy Markdown View Source

Relationship-aware layout for one caller-owned native form control.

field normalizes identity, values, errors, and presentation state, then passes the protected control attributes to the required control slot. It does not create a form, changeset, validation lifecycle, or submission.

Summary

Functions

field(assigns)

Renders label, caller-owned control, optional help, and visible field errors.

Functions

field(assigns)

Renders label, caller-owned control, optional help, and visible field errors.

The control slot receives a map containing id, name, value, aria_describedby, aria_invalid, required, disabled, and pending.

Attributes

  • field (:any) - Defaults to nil.
  • id (:string) - Defaults to nil.
  • name (:string) - Defaults to nil.
  • value (:any) - Defaults to {:shadcn_ui, :not_provided}.
  • errors (:any) - Defaults to {:shadcn_ui, :not_provided}.
  • error_mode (:atom) - Defaults to :used_input. Must be one of :used_input, :always, or :hidden.
  • used (:boolean) - Defaults to false.
  • translate_error (:any) - Defaults to nil.
  • pending (:boolean) - Defaults to false.
  • required (:boolean) - Defaults to false.
  • optional (:boolean) - Defaults to false.
  • disabled (:boolean) - Defaults to false.
  • describedby (:any) - Defaults to nil.
  • class (:any) - Defaults to nil.
  • Global attributes are accepted.

Slots

  • label (required)
  • control (required)
  • help