SurfaceBulma.Form.Checkbox (surface_bulma v0.6.1)
The checkbox component
Properties
- id :string - The id of the corresponding input field
- opts :keyword, default: [] - Options list
- class :css_class - Class or classes to apply to the input
- value :string - Value to pre-populated the input
- name :string - The name of the corresponding input field
- field :any, from_context: {Surface.Components.Form.Field, :field} - An identifier for the input
- form :form, from_context: {Surface.Components.Form, :form} - An identifier for the form
- values :keyword, default: [] - List values that will be sent as part of the payload triggered by an event
- 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".
- disabled :boolean, default: false - Disable selection
- label_class :css_class, default: nil - Extra classes for the label
- field_class :css_class, default: [] - Extra classes for the field
Slots
- default - The text / label of the checkbox
Events
- window_keyup - Triggered when a key on the keyboard is released (window-level)
- window_keydown - Triggered when a key on the keyboard is pressed (window-level)
- keyup - Triggered when a key on the keyboard is released
- keydown - Triggered when a key on the keyboard is pressed
- window_focus - Triggered when the page receives focus
- window_blur - Triggered when the page loses focus
- focus - Triggered when the component receives focus
- blur - Triggered when the component loses focus
- capture_click - Triggered when the component captures click
- click_away - Triggered when a click event happens outside of the element
- click - Triggered when the component receives click
Summary
Functions
Callback implementation for Surface.Component.render/1
.
Functions
Link to this function
render(assigns)
Callback implementation for Surface.Component.render/1
.