Reference > v-ons-checkbox

v-ons-checkbox

A checkbox element. The component will automatically render as a Material Design checkbox on Android devices. Most attributes that can be used for a normal <input type="checkbox"> element can also be used on the <ons-checkbox> element.

Tutorial

Checkboxes

Checkboxes are created with the VOnsCheckbox component. It works almost exactly the same way as a normal <input type="checkbox"> tag.

An attribute input-id is provided to set the ID of the inner native element. This is useful for HTMLLabel elements: <label for="some-inner-input">.

Using v-model

Every input is compatible with v-model directive. Checkboxes can be bound to arrays or booleans normally. The only exception are modifiers. There is, however, a workaround for lazy modifier:

<v-ons-input v-model="something" model-event="change"></v-ons-input>

This will use change event instead of input when updating v-model.

See also

Props

Name Type Description
inputId String Specify the “id” attribute of the inner <input> element. This is useful when using <label for="..."> elements. Optional.
modelEvent Boolean The native event which should trigger the update:modelValue event. Optional.
modelValue Boolean Whether the checkbox is checked or not. Optional.

Preset Modifiers

Name Description
material Displays a Material Design checkbox.
noborder iOS borderless checkbox.

Events

Name Description
update:modelValue Fired right after the event set in the modelEvent prop.
update:modelValue

Fired right after the event set in the modelEvent prop.

Parameters
Name Type Description

Need Help?

If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.