Radio Button

Radio buttons are used when the user needs to select one option from a set.

This UI component is best used when there is enough space, since all the options are visible at once. If you need to save space, a better UI choice would be the Dropdown, which only shows the selected item and the others are hidden after the selection.

Basic Usage

The following example will render a simple Radio button with a label.

<label>
    <input type="radio" mbsc-radio data-label="The label of the Radio button" />
</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 radio 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, the disabled or the value attributes (and so on...).

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

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

Selecting programmatically

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

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

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

const checkedState = radioInstance.checked; // get the selected state as a boolean value
radioInstance.checked = false; // will deselect the radio button

Disabled state

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

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

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

Changing options dynamically

The options of the radio 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 radio:

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

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

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

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

Tree Shaking for styles

Tree shaking is a term commonly used in web development and particularly in JavaScript for unused code removal. Since websites are served (mostly) over the network, loading times depend on content size, so minification and unused content elimination plays a major role in making webapps fluid.

For the JavaScript part, popular frameworks already have the treeshaking built in, so the components that are not used will be left out from the built project.

Eliminating unused styles

In case of the styles, leaving out the unused rules is not as straight forward.
The overarching idea is that CSS selectors match elements in the DOM, and those elements in the DOM come from all sorts of places: your static templates, dynamic templates based on server-side state, and of course, JavaScript, which can manipulate the DOM in any way at all, including pull things from APIs and third parties.

Sass variables to the rescue

The Mobiscroll Library comes with a modular SASS bundle, that can be configured which component styles and which themes to leave in and out for the compiled css file.

Every component and theme has a SASS variable that can be turned on or off. If the variable is falsy the styles that it needs will not be added to the bundle.

// include the ios theme
$mbsc-ios-theme: true;

// include the components:
$mbsc-datepicker: true;
$mbsc-eventcalendar: true;
        
@import "@mobiscroll/jquery/dist/css/mobiscroll.modular.scss"

In the above example the styles needed for the eventcalendar and datepicker will be included and only for the ios theme. All other components (like select or grid-layout) and all other themes will be left out from the bundle.

Here's the complete list of the components and themes that can be used:

• $mbsc-datepicker
• $mbsc-eventcalendar
• $mbsc-forms
• $mbsc-grid-layout
• $mbsc-popup
• $mbsc-select

• $mbsc-ios-theme
• $mbsc-material-theme
• $mbsc-windows-theme

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