Textfields

Textbox

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

Basic usage
<label>
  <input mbsc-input data-label="Input label" />
</label>
            
<!-- With icons -->
<label>
  <input mbsc-input data-start-icon="home" data-end-icon="eye" />
</label>
            

Password

The password toggle can be used to hide or show the entered password using icons

With toogle
<label>
    <input data-lable="Password Toggle show" mbsc-input placeholder="Password" data-password-toggle="true" />
</label>

Textarea

Textareas will auto-grow based on the entered content up until to 10 lines.

Basic usage
<label>
    <textarea data-label="About me" mbsc-textarea id="aboutme"></textarea>
</label>
            
<!-- With icons -->
<label>
  <textarea mbsc-textarea data-label="About" data-start-icon="home" data-end-icon="eye"></textarea>
</label>

Input style

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

Underline input style
<label>
    <input data-label="Username" mbsc-input id="username" data-input-style="underline" />
</label>
Box input style
<label>
    <input data-label="Username" mbsc-input id="username" data-input-style="box" />
</label>
Outline input style
<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.

Stacked label style
<label>
    <input data-label="Username" mbsc-input id="username" data-label-style="stacked" />
</label> 
Inline label style
<label>
    <input data-label="Username" mbsc-input id="username" data-label-style="inline" />
</label>
    
Floating label style
<label>
    <input mbsc-input id="username" data-label-style="floating" />
</label>
    

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:

HTML
<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>

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:

HTML
<label>
    <input id="my-input" type="text" disabled mbsc-input data-label="My Input" />
</label>
JS
// 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 });

Options

Name Type Default value Description
disabled Boolean false Initial disabled state of the component.
endIcon 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.
endIconSrc String undefined Specify the icon/image src patch for the form component which will be displayed on the end of the component. Use startIconSrc option for specifying icon to the opposite side.
endIconSvg Svg 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 Boolean undefined Controls the error state of the component. If true error styles will be displayed.
errorMessage String undefined Controls the error message of the component. If error option is set to true the error message will be displayed.
inputStyle String 'underline' Defines the input rendering mode. By default the input has the underline styling. Possible values:
  • 'underline'
  • 'box'
  • 'outline'
label String undefined Sets the label of component.
labelStyle 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'
passwordToggle boolean undefined Defines the password toggle visibility on a password field.
rtl Boolean false Right to left display.
startIcon 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.
startIconSrc String undefined Specify the icon/image src patch for the form component which will be displayed on the end of the component. Use endIconSrc option for specifying icon to the opposite side.
startIconSvg Svg 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 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.

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 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.

Hereinafter you will see all the variables that are specific to the Input component or affect its look:

Textfields theming

Global variables of the Input, Password, Textarea and Dropdown

Variable name Description
$mbsc-input-background-light Sets the background color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-input-background-dark
$mbsc-input-text-light Sets the text color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-input-text-dark
$mbsc-form-input-border-light Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-form-input-border-dark
$mbsc-input-accent-light Sets the accent color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-input-accent-dark
$mbsc-form-error-light Sets the error color of the Input, 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-input-text
#000000
Sets the text color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-input-border
#cccccc
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-form-error
#d8332a
Sets the error color of the Input, along with the Password, Textarea and Dropdown 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-dark-input-text
#ffffff
Sets the text color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-dark-input-border
#333333
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-ios-dark-form-error
#d8332a
Sets the error color of the Input, along with the Password, Textarea and Dropdown 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-input-border
#999999
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-input-accent
#0078d7
Sets the accent color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-form-error
#d30101
Sets the error color of the Input, along with the Password, Textarea and Dropdown 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-dark-input-border
#737373
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-dark-input-accent
#0078d7
Sets the accent color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-windows-dark-form-error
#d30101
Sets the error color of the Input, along with the Password, Textarea and Dropdown 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-input-text
#6d6d6d
Sets the text color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-input-border
#6d6d6d
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-input-accent
#009688
Sets the accent color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-form-error
#de3226
Sets the error color of the Input, along with the Password, Textarea and Dropdown 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 Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-dark-input-text
#d4d4d4
Sets the text color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-dark-input-border
#d4d4d4
Sets the border color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-dark-input-accent
#81ccc4
Sets the accent color of the Input, along with the Password, Textarea and Dropdown fields.
$mbsc-material-dark-form-error
#de3226
Sets the error color of the Input, along with the Password, Textarea and Dropdown fields.

Underline examples

Box examples

Outline examples

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