Checkbox Component API
The form_checkbox
component is Vue.js driven child component of the form
component and is used to collect user input.
All child components form_*
(including this component) have to be placed within the scope of the parent form
component, without any other Vue.js driven component like toggle
, async
creating a new scope between the child component and the parent form component! Non-Vue.js component can be placed between form
and form_*
without issues!
Parameters
key - required
Defines the key which should be used when posting the form data to the server.
options
Can either be nil, an Array or Hash:
When not given
will render a single checkbox which can switch between true
and false
as value for the given key. Will be nil
initially. The boolean value (or nil) will be sent to the server when submitting the form.
Array usage
will render a collection of checkboxes and their corresponding labels.
Multiple checkboxes can be selected. Data will be sent as an Array of selected values to the server when submitting the form.
Hash usage
will render a collection of checkboxes and their corresponding labels.
The hash values will be used as values for the checkboxes, the keys as displayed label values.
Multiple checkboxes can be selected. Data will be sent as an Array of selected values to the server when submitting the form.
ActiveRecord Enum Mapping
If you want to use ActiveRecord enums as options for your radio input, you can use the enum class method:
Multiple checkboxes can be selected. Data will be sent as an Array of selected values to the server when submitting the form.
disabled_values
NOT IMPLEMENTED YET
init
NOT IMPLEMENTED YET
label
An applied label is only visible, when using a single checkbox without options.
You can also use the label
component in order to create a label for this input.
Custom Checkbox
If you want to create your own radio component, that's easily done since v.1.3.0
.
Create your own Ruby component:
app/matestack/components/my_form_checkbox.rb
Create the corresponding Vue.js component:
Generic code:
app/matestack/components/my_form_checkbox.js
Don't forget to require the custom component JavaScript according to your JS setup!
Finally, use it within a
matestack_form
:
Last updated