This version of the documentation is outdated. Check the latest version here!

Dropdown

The Dropdown component uses the HTML select element and adds custom styling and additional functionality.

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

HTML
<label>
    <select data-label="Choose one" mbsc-dropdown id="choose">
        <option>Option 1</option>
        <option>Option 2</option>
        <option>Option 3</option>
    </select>
</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 dropdown via data- attributes with one exception. The exception is the disabled attribute, that don't need the data- prefix, since the native select supports it.

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

HTML
<label>
    <select data-rtl="true" data-label="Choose one" mbsc-dropdown id="choose">
        <option>Option 1</option>
        <option>Option 2</option>
        <option>Option 3</option>
    </select>
</label>

Disabled state

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

<label>
    <select disabled data-label="Choose one" mbsc-dropdown id="choose">
        <option>Option 1</option>
        <option>Option 2</option>
        <option>Option 3</option>
    </select>
</label>

Changing options dynamically

The settings of the dropdown 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 setting on an input:

HTML
<label>
    <select id="my-dropdown" disabled data-label="Choose one" mbsc-dropdown id="choose">
        <option>Option 1</option>
        <option>Option 2</option>
        <option>Option 3</option>
    </select>
</label>
JS
// get the input element
const selectElement = $('#my-dropdown')[0];
// get the instance of the dropdown component
const dropdownInstance = mobiscroll.getInst(selectElement);
// set the disabled setting to false
dropdownInstance.setOptions({ disabled: false });

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

Options

Name Data attribute Type Default value Description
disabled data-disabled Boolean false Initial disabled state of the component. This will take no effect in inline display mode.
endIcon data-end-icon String undefined Specify the icon name for the form components which will be displayed on the end of the component. Use startIcon option for specifying icon to the opposite side.
endIconSvg data-end-icon-svg String undefined Specify the icon svg for the form components which will be displayed on the end of the component. Use startIconSvg option for specifying icon to the opposite side.
error data-error Boolean undefined Controls the error state of the component. If true error styles will be displayed.
errorMessage data-error-message String undefined Controls the error message of the component. If error option is set to true the error message will be displayed.
inputStyle data-input-style String 'underline' Defines the input rendering mode. By default the input has the underline styling. Possible values:
  • 'underline'
  • 'box'
  • 'outline'
label data-label String undefined Sets the label of component.
labelStyle data-label-style String undefined Defines the position of the label. The default label style depends on the theme option. With the 'ios' theme the inputs have inline labels, with 'mobiscroll', 'material' and 'windows' themes the default label position is stacked. Possible values:
  • 'stacked'
  • 'inline'
  • 'floating'
rtl data-rtl Boolean false Right to left display.
startIcon data-start-icon String undefined Specify the icon name for the form component which will be displayed on the end of the component. Use endIcon option for specifying icon to the opposite side.
startIconSvg data-start-icon-svg String undefined Specify the icon svg for the form component which will be displayed on the end of the component. Use endIconSvg option for specifying icon to the opposite side.
theme data-theme String undefined

Sets the visual appearance of the component.

If it is 'auto' or undefined, the theme will automatically be chosen based on the platform. If custom themes are also present, they will take precedence over the built in themes, e.g. if there's an iOS based custom theme, it will be chosen on the iOS platform instead of the default iOS theme.

Supplied themes:
  • 'ios' - iOS theme
  • 'material' - Material theme
  • 'windows' - Windows theme
It's possible to modify theme colors or create custom themes.
Make sure that the theme you set is included in the downloaded package.
themeVariant data-theme-variant String undefined

Controls which variant of the theme will be used (light or dark).

Possible values:
  • 'light' - Use the light variant of the theme.
  • 'dark' - Use the dark variant of the theme.
  • 'auto' or undefined - Detect the preferred system theme on devices where this is supported.

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 '-dark', e.g.: 'my-theme' and 'my-theme-dark'.

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:

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"
It's important that you override the variables BEFORE the scss file import, otherwise it won't make any difference.
Here's a complete guide on how to set up Mobiscroll with SASS support

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.

Example on configuring the styles
// 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.

It's important that you override the variables BEFORE the scss file import, otherwise it won't make any difference.

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

Some components use others internally, so it might happen that even though you don't want to include some styles, they will still end up in your bundle.
For example if you don't want to include the form components (input, button, segmented, etc...), but you are using the select component, the styles for the mobiscroll buttons, will still be in, because of the dependency.

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

Dropdown theming

Global variables of the Dropdown, Input, Password and Textarea

Variable name Description
$mbsc-input-background-light Sets the background color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-input-background-dark
$mbsc-input-text-light Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-input-text-dark
$mbsc-form-input-border-light Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-form-input-border-dark
$mbsc-input-accent-light Sets the accent color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-input-accent-dark
$mbsc-form-error-light Sets the error color of the Dropdown, along with the other form elements.
$mbsc-form-error-dark

iOS theme

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

Variable name Default value Description
$mbsc-ios-input-background
#ffffff
Sets the background color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-input-text
#000000
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-input-border
#cccccc
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-form-error
#d8332a
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

iOS Dark theme

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

Variable name Default value Description
$mbsc-ios-dark-input-background
#0f0f0f
Sets the background color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-dark-input-text
#ffffff
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-dark-input-border
#333333
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-ios-dark-form-error
#d8332a
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

Underline examples

Box examples

Outline examples

Windows theme

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

Variable name Default value Description
$mbsc-windows-input-text
#262626
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-input-border
#999999
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-input-accent
#0078d7
Sets the accent color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-form-error
#d30101
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

Windows Dark theme

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

Variable name Default value Description
$mbsc-windows-dark-input-text
#ffffff
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-dark-input-border
#737373
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-dark-input-accent
#0078d7
Sets the accent color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-windows-dark-form-error
#d30101
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

Underline examples

Box examples

Outline examples

Material theme

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

Variable name Default value Description
$mbsc-material-input-background
#eeeeee
Sets the background color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-input-text
#6d6d6d
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-input-border
#6d6d6d
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-input-accent
#009688
Sets the accent color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-form-error
#de3226
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

Material Dark theme

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

Variable name Default value Description
$mbsc-material-dark-input-background
#303030
Sets the background color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-dark-input-text
#d4d4d4
Sets the text color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-dark-input-border
#d4d4d4
Sets the border color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-dark-input-accent
#81ccc4
Sets the accent color of the Dropdown, along with the Input, Password and Textarea fields.
$mbsc-material-dark-form-error
#de3226
Sets the error color of the Dropdown, along with the Input, Password and Textarea fields.

Underline examples

Box examples

Outline examples

If you are looking for the generic Form variables, check out the tables here.