PhoenixDuskmoon.Component.Form.Checkbox (PhoenixDuskmoon v7.2.1)

View Source

Checkbox component for multiple selection.

Examples

<.dm_form for={@form} phx-submit="save">
  <.dm_checkbox field={@form[:agree]} label="I agree to terms" />
  <.dm_checkbox field={@form[:newsletter]} label="Subscribe to newsletter" color="success" />
  <.dm_checkbox field={@form[:features]} label="Enable advanced features" size="lg" />
</.dm_form>

Attributes

  • field - Phoenix form field
  • label - Checkbox label text
  • size - Checkbox size: xs, sm, md, lg (default: md)
  • color - Checkbox color: primary, secondary, accent, info, success, warning, error (default: primary)
  • disabled - Disable the checkbox
  • indeterminate - Set indeterminate state
  • class - Additional CSS classes
  • label_class - Additional CSS classes for label
  • checkbox_class - Additional CSS classes for checkbox element

Summary

Functions

dm_checkbox(assigns)

Functions

dm_checkbox(assigns)

Attributes

  • id (:any) - Defaults to nil.
  • name (:any)
  • value (:any)
  • field (Phoenix.HTML.FormField) - a form field struct retrieved from the form.
  • checked (:boolean) - Defaults to false.
  • label (:string) - Defaults to nil.
  • size (:string) - Defaults to "md". Must be one of "xs", "sm", "md", or "lg".
  • color (:string) - Defaults to "primary". Must be one of "primary", "secondary", "accent", "info", "success", "warning", or "error".
  • disabled (:boolean) - Defaults to false.
  • indeterminate (:boolean) - Defaults to false.
  • class (:string) - Defaults to nil.
  • label_class (:string) - Defaults to nil.
  • checkbox_class (:string) - Defaults to nil.
  • Global attributes are accepted.