SurfaceBootstrap.Form.Checkbox (surface_bootstrap v0.2.5)

The checkbox component

Properties

  • field :atom, required: true - The the field on the changeset.
  • disabled :boolean, default: false - Disable selection.
  • opts :keyword, default: [] - Any opts you want to pass on to internal Surface.Checkbox and Phoenix.HTML.Form.checkbox/3.
  • class :css_class, default: [] - Class to apply to input.
  • checkbox_right :boolean - Move checkbox to right hand side.
  • switch :boolean - Show checkbox in switch style.
  • inline :boolean - Show checkbox inline.
  • label :string - Label if simple text, will be overwritten by slot content for complex checkboxes.

Slots

  • default - The text / label of the checkbox.

Link to this section Summary

Link to this section Functions

Callback implementation for Phoenix.LiveComponent.mount/1.

Link to this function

render(assigns)

Callback implementation for Phoenix.LiveComponent.render/1.

Link to this function

update(assigns, socket)

Callback implementation for Phoenix.LiveComponent.update/2.