Textfields

Input types

<label>
    <input mbsc-input data-label="Username" type="text" />
</label> 

<label>
    <input mbsc-input data-label="Password" type="password" data-password-toggle="true" />
</label> 

<label>
    <input mbsc-input data-label="File upload" type="file" />
</label> 

<label>
    <textarea mbsc-textarea data-label="About"></textarea>
</label> 

<label>
    <input mbsc-input data-label="Date field" type="date" />
</label> 

<label>
    <input mbsc-input data-label="Number field" type="number" />
</label> 

Input style

This option can be used for customizing your form input and textarea rendering.

<label>
    <input data-label="Username" mbsc-input id="username" data-input-style="underline" />
</label>

<label>
    <input data-label="Username" mbsc-input id="username" data-input-style="box" />
</label>

<label>
    <input data-label="Username" mbsc-input id="username" data-input-style="outline" />
</label>

Label style

With this option you can define the position of the label.

<label>
    <input data-label="Username" mbsc-input id="username" data-label-style="stacked" />
</label> 

<label>
    <input data-label="Username" mbsc-input id="username" data-label-style="inline" />
</label>
    

<label>
    <input mbsc-input id="username" data-label-style="floating" />
</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 input via data- attributes with one ecxeption. The exception is the disabled attribute, that don't need the data- prefix, since the native input supports it.

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

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

Disabled state

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

<!-- This will create a disabled input -->
<label>
    <input type="text" disabled mbsc-input data-label="Initially disabled input" />
</label>
<!-- The following will not be disabled -->
<label>
    <input type="text" mbsc-input data-label="Initially not disabled input" />
</label>

Setting the value

Setting the input field value programmatically:

<label>
    <input id="my-input" type="text" mbsc-input data-label="My Input" />
</label>

$('#my-input').mobiscroll('getInst').value = 'myValue';

Changing options dynamically

The settings of the input 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:

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

// get the input element
const inputElement = $('#my-inpit')[0];
// get the instance of the input component
const inputInstance = mobiscroll.getInst(inputElement);
// set the disabled setting to false
inputInstance.setOptions({ disabled: false });

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

Textfields theming

Global variables of the Input, Password, Textarea and Dropdown

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:

Underline examples

Box examples

Outline examples

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:

Underline examples

Box examples

Outline examples

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:

Underline examples

Box examples

Outline examples

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