Checkbox

Checkboxes are used when there are lists of options and the user may select any number of choices, including zero, one, or several. In other words, each checkbox is independent of all other checkboxes in the list, so checking one box doesn't uncheck the others.

Basic Usage

The following example will render a simple Checkbox with a label.

<label>
    <input type="checkbox" mbsc-checkbox data-label="The label of the Checkbox" />
</label>

Auto initialization

If the component is added later to the DOM, e.g. with an Ajax page load, a custom function named enhance needs to be called in order to initialize the dynamically added component. When the enhance function is called on a DOM element, all form elements will be initialized inside this element.

$.get('/myform', function (responseHtml) {
    var $page = $('#page');
    $page.html(responseHtml);
    mobiscroll.enhance($page[0]);
});

Passing options

All the options can be passed to the checkbox via data- attributes with exceptions of the native input supported ones. The attributes that the native html input supports can be passed directly without the data- prefix. For example thechecked or the disabled attributes (and so on...).

In this example we pass the rtl and the disabled options:

<label>
    <input type="checkbox" mbsc-checkbox data-rtl="true" disabled data-label="This is Disabled" />
</label>

Selecting programmatically

Selecting the value for a checkbox means setting the checked state of it. This can be done through the instance. For example:

<label>
    <input id="my-checked-checkbox" type="checkbox" checked mbsc-checkbox data-label="Initially checked" />
</label>

// get the input element, the checkbox was initialized on
const inputElement = $('#my-checked-checkbox');
// get the instance of the Checkbox component
const checkboxInstance = mobiscroll.getInst(inputElement);

const checkedState = checkboxInstance.checked; // get the selected state as a boolean value
checkboxInstance.checked = false; // will deselect the checkbox

Disabled state

The underlying input's disabled attribute will be taken into account at initialization time. For example:

<!-- This will create a disabled checkbox -->
<label>
    <input type="checkbox" checked disabled mbsc-checkbox data-label="Initially selected and disabled" />
</label>

<!-- The following will not be disabled -->
<label>
    <input type="checkbox" checked mbsc-checkbox data-label="Initially selected and not disabled" />
</label>

Changing options dynamically

The options of the checkbox can be changed dynamically using the setOptions method on the instance itself, or the global setOptions method.
Here is an example on how to change the disabled option on a single checkbox:

<label>
    <input id="my-checkbox" type="checkbox" disabled mbsc-checkbox data-label="My checkbox" />
</label>

// get the input element, the checkbox was initialized on
const inputElement = $('#my-checkbox');
// get the instance of the checkbox component
const checkboxInstance = mobiscroll.getInst(inputElement);

// set the disabled setting to false
checkboxInstance.setOptions({ disabled: false });

For many more examples - simple and complex use-cases - check out the checkbox demos for jquery.

Options

Customizing the appearance

While the provided pre-built themes are enough in many use cases, most of the times on top of adapting to a specific platform, you'd also like to match a brand or color scheme. Mobiscroll provides various ways to achieve this:

• Create custom themes using the theme builder - the custom themes can be also built using out theme builder, on a graphical user interface, without any coding, or the need for Sass support in your project.
• Create custom themes using Sass - use this, if you need multiple themes with different color variatons, in case you have pages with different colors, or you'd like to users to customize the colors of your app.
• Override the Sass color variables - the straightforward way to change the colors in one place throughout the application.

Override the Sass Color Variables

A convenient way to customize the colors of the Mobiscroll components is to override the Sass color variables.

Let's say your branding uses a nice red accent color, and you'd like that color to appear on the Mobiscroll components as well, while still using platform specific themes (e.g. ios on iOS devices, material on Android devices, and mobiscroll on desktop). You can override the accent color for every theme:

$mbsc-ios-accent: #e61d2a;
$mbsc-material-accent: #e61d2a;
$mbsc-mobiscroll-accent: #e61d2a;

@import "~@mobiscroll/JQuery/dist/css/mobiscroll.jquery.scss"

You can also customize the colors on many levels:

1. Theme specific variables (ex. $mbsc-material-background, $mbsc-ios-dark-text) are applied to all components in a theme. Complete list of variables here.
2. Component specific global variables (ex. $mbsc-card-background-light, $mbsc-listview-text-dark) are applied to all themes for a specific component.
3. Component and theme specific variables (ex. $mbsc-ios-dark-form-background, $mbsc-material-input-text) are applied to a specific theme and a specific component.

For many more examples - simple and complex use-cases - check out the checkbox demos for jquery.

Checkbox theming

Global variables of the Checkbox

Below you will find a list of SASS variables that affect the Checkbox:

If you really want to get sophisticated or if a color doesn't look good on a specific theme and you want to overwrite it, you can fine tune all of the above variables individually for each theme. Below are the complete list of variables broken down to themes:

iOS theme

The following variables are specific to the iOS theme light variant:

iOS Dark theme

The following variables are specific to the iOS theme dark variant:

Windows theme

The following variables are specific to the Windows theme light variant:

Windows Dark theme

The following variables are specific to the Windows theme dark variant:

Material theme

The following variables are specific to the Material theme light variant:

Material Dark theme

The following variables are specific to the Material theme dark variant:

Mobiscroll theme

The following variables are specific to the Mobiscroll theme light variant:

Mobiscroll Dark theme

The following variables are specific to the Mobiscroll theme dark variant:

If you are looking for the generic Form variables and how they affect the form in general, check out the tables and pictures here.