Surface.Components.Form.Checkbox (surface v0.3.0) View Source
Defines a checkbox.
Provides a wrapper for Phoenix.HTML.Form's checkbox/3
function.
All options passed via opts
will be sent to checkbox/3
, value
and
class
can be set directly and will override anything in opts
.
Examples
<Checkbox form="user" field="color" opts={{ autofocus: "autofocus" }}>
Properties
- form :form - An identifier for the form.
- field :atom - An identifier for the input.
- id :string - The id of the corresponding input field.
- name :string - The name of the corresponding input field.
- value :string - Value to pre-populated the input.
- class :css_class - Class or classes to apply to the input.
- opts :keyword, default: [] - Options list.
- blur :event - Triggered when the component loses focus.
- focus :event - Triggered when the component receives focus.
- capture_click :event - Triggered when the component receives click.
- keydown :event - Triggered when a button on the keyboard is pressed.
- keyup :event - Triggered when a button on the keyboard is released.
- checked_value :any, default: true - The value to be sent when the checkbox is checked. Defaults to "true".
- hidden_input :boolean, default: true - Controls if this function will generate a hidden input to submit the unchecked value or not, defaults to "true"..
- unchecked_value :any, default: false - The value to be sent when the checkbox is unchecked, defaults to "false"..
Link to this section Summary
Functions
Callback implementation for Phoenix.LiveComponent.mount/1
.
Callback implementation for Phoenix.LiveComponent.render/1
.
Callback implementation for Phoenix.LiveComponent.update/2
.
Link to this section Functions
Callback implementation for Phoenix.LiveComponent.mount/1
.
Callback implementation for Phoenix.LiveComponent.render/1
.
Callback implementation for Phoenix.LiveComponent.update/2
.