Switch

The Switch is a two value control. It is like a physical toggle switch, it has an on and an off state that is represented as a boolean value.

Basic usage

The following example will create a simple switch with a label.

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

For being more informative a description and a color can also be passed to the switch.

<!-- Label and description for more info -->
<label>
    <input type="checkbox" mbsc-switch data-label="Front door" data-description="Controls the lock of the front door." />
</label>

<!-- Different color switches -->
<label>
    <input type="checkbox" mbsc-switch data-color="danger" data-label="Sync on mobile data" />
</label>
<label>
    <input type="checkbox" mbsc-switch color="info" label="Email notification" />
</label>

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

Passing options

All the options can be passed to the switch via data- attributes with two exceptions. The exceptions are the checked and the disabled attributes, that don't need the data- prefix, since the native input supports them.

For example, when passing the rtl and the disabled options:

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

Switching programmatically

Getting and setting the checked state of the switch can be done through the switch instance. For example:

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

// get the input element, the switch was initialized on
const inputElement = $('#my-checked-switch')[0];
// get the instance of the switch component
const switchInstance = mobiscroll.getInst(inputElement);

const checkedState = switchInstance.checked; // get the switch on/off state as a boolean value
switchInstance.checked = false; // will turn the switch off

Disabled state

The underlying checkbox disabled property will be taken into account at initialization time. For example:

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

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

Changing options dynamically

The settings of the switch can be changed dynamically using the setOptions method on the instance itself, or the setOptions method of the mobiscroll object.
Here is an example on how to change the disabled setting on a single switch:

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

// get the input element, the switch was initialized on
const inputElement = $('#my-switch')[0];
// get the instance of the switch component
const switchInstance = mobiscroll.getInst(inputElement);

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

For many more examples - simple and complex use-cases - check out the switch 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.

Global variables of the Switch

These variables are applied to all base themes: iOS, material, windows and mobiscroll.
They all come in pairs. One for the light and one for the dark variant in each theme.

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

iOS Dark theme

Material theme

Material Dark theme

Windows theme

Windows Dark theme