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>
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 programatically
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>
import { getInst } from 'the mobiscroll bundle';
// get the input element, the radio was initialized on
const inputElement = document.getElementById('my-checked-radio');
// get the instance of the Radio component
const radioInstance = 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>
import { getInst } from 'the mobiscroll bundle';
// get the input element, the radio was initialized on
const inputElement = document.getElementById('my-radio');
// get the instance of the radio component
const radioInstance = 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 javascript.
Options
Name | Type | Default value | Description |
---|---|---|---|
checked | Boolean | undefined |
When true, sets the group to this Radio's value. |
color | String | undefined |
A predefined color to style the component. Supported values are:
|
description | String | undefined |
A description that shows up under the label of the component. |
disabled | Boolean | false |
Initial disabled state of the component. |
label | String | undefined |
Sets the label of component. |
name | String | undefined |
The name attribute for the Radio button. Each unique name defines a group, and the same name should be used on each component that goes into the same group. |
value | String | undefined |
The value attribute is a string containing the Radio button's value. |
position | String | 'end' |
Sets the position of the switch handle depending on the RTL setting. It can be 'start' or 'end' . When in LTR mode, the 'start' will set the handle position to the left (a.k.a. from left to right the switch will start with the handle) and the 'end' will set it to the right - so the handle goes to the end of the switch.In RTL mode, the 'start' will position the hande to the right. The 'end' will position the handle to the left in this case.
|
rtl | Boolean | false |
Right to left display. |
theme | String | undefined |
Sets the visual appearance of the component.
If it is
Make sure that the theme you set is included in the downloaded package.
|
themeVariant | String | undefined |
Controls which variant of the theme will be used (light or dark). Possible values:
To use the option with custom themes, make sure to create two custom themes,
where the dark version has the same name as the light one, suffixed with |
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/Javascript/dist/css/mobiscroll.javascript.scss"
You can also customize the colors on many levels:
- Theme specific variables (ex.
$mbsc-material-background
,$mbsc-ios-dark-text
) are applied to all components in a theme. Complete list of variables here. - Component specific global variables (ex.
$mbsc-card-background-light
,$mbsc-listview-text-dark
) are applied to all themes for a specific component. - 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.
Hereinafter you will see all the variables that are specific to the Radio component or affect its look:
For many more examples - simple and complex use-cases - check out the radio button demos for javascript.