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

Copy Markdown View Source

Native checkbox with explicit boolean or repeated-value submission semantics.

Boolean mode emits Phoenix's same-name hidden unchecked sentinel immediately before the visible checkbox. Multiple mode normalizes the name to [], uses the explicit option value, and emits no sentinel. Checked state is a rendered snapshot; the browser and consuming application own changes and submission.

Summary

Functions

checkbox(assigns)

Renders one native boolean or repeated-value checkbox field.

Functions

checkbox(assigns)

Renders one native boolean or repeated-value checkbox field.

Attributes

  • field (:any) - Defaults to nil.
  • id (:string) - Defaults to nil.
  • name (:string) - Defaults to nil.
  • mode (:atom) - Defaults to :boolean. Must be one of :boolean, or :multiple.
  • value (:any) - Defaults to {:shadcn_ui, :not_provided}.
  • checked (:boolean) - Defaults to nil.
  • checked_value (:string) - Defaults to "true".
  • unchecked_value (:string) - Defaults to "false".
  • 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.
  • form (:string) - Defaults to nil.
  • describedby (:any) - Defaults to nil.
  • class (:any) - Defaults to nil.
  • field_class (:any) - Defaults to nil.
  • label_class (:any) - Defaults to nil.
  • Global attributes are accepted. Supports all globals plus: ["autofocus"].

Slots

  • label (required)
  • help