Forms

About

The form component adds styling to standard html form elements (textboxes, textareas, selects, checkboxes, radio buttons, submit buttons) giving them a native like look and feel on various platforms.

Starting from 4.8.0 the form elements can be used separately using their own attributes to initialize.

Initialization

Auto initialization

To auto-initialize the form elements, simply put the mbsc-form attribute on the container element. The form elements inside the container will be automatically intialized when the page is loaded.

<div id="myform" mbsc-form>
    <label>
        Username
        <input mbsc-input id="username" />
    </label>
    <label>
        Password
        <input mbsc-input id="password" type="password" />
    </label>
    <button mbsc-button type="submit">Sign In</button>
</div>

The initialization will use the default options. The defaults can be set in the mobiscroll.settings object, after the Mobiscroll scripts are loaded, but before the page load (document ready) event is fired, in order to have effect on the form initialization.

mobiscroll.settings = {
    theme: 'ios',
    lang: 'de'
};

If the form container is added later to the DOM, e.g. with an Ajax page load, a custom event named mbsc-enhance needs to be triggered in order to initialize the dynamically added content.
When the mbsc-enhance event is triggered on a DOM element, all form elements will be initialized inside all descendant elements with the mbsc-form attribute (including itself).

var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function() {
    if (xhr.readyState == XMLHttpRequest.DONE) {
        var page = document.getElementByID('page');
        page.innerHTML = xhr.responseText;
        page.dispatchEvent(new Event('mbsc-enhance')); 
    }
}
xhr.open('GET', '/myform', true);
xhr.send();
    

Manual Initialization

The form can also initialized manually, just like any other Mobiscroll component.

<div id="myform">
    <label>
        Username
        <input mbsc-input id="username" />
    </label>
    <label>
        Password
        <input mbsc-input id="password" type="password" />
    </label>
    <button mbsc-button type="submit">Sign In</button>
</div>

mobiscroll.form('#myform', {
    theme: 'material'
});

If the form container is added later to the DOM, e.g. with an Ajax page load, call the initialization right after the content is appended in the DOM.

var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function() {
    if (xhr.readyState == XMLHttpRequest.DONE) {
        var page = document.getElementByID('page'),

        page.innerHTML = xhr.responseText;

        mobiscroll.form('#myform', {
            theme: 'mobiscroll'
        });
    }
}
xhr.open('GET', '/myform', true);
xhr.send();

When elements are dynamically added to an already initialized form, call the refresh method to initialize the new elements.

mobiscrollInstance.refresh();

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

Typescript Types

When using with typescript, the following types are available for the Form:

Options

Events

mobiscroll.forms('#mobiscroll', {
    onInit: function (event, inst) {
    }
});

Methods

mobiscrollInstance.getInst();

mobiscrollInstance.option({
    display: 'bottom',
    lang: 'de'
});

mobiscrollInstance.refresh();

mobiscrollInstance.tap('#element', function () { alert("It's a tap!"); });

Localization

Validation

The Mobiscroll Forms component does not have built in validation mechanism, but provides error state stylings. Use the mbsc-err css class on the form element's container and the mbsc-err-msg css class on the error message:

<label class="mbsc-err">
    Username
    <input mbsc-input id="username" />
    <span class="mbsc-err-msg">Username is required.</span>
</label>
    

The above code sample makes a Mobiscroll input to show up as invalid. The text "Username is required" will be shown as the error message.

A functional Example

The following is a simple example on how to validate a login form using a functional approach. The validation requirements for each field are added with standard attributes like required, minlength and the type of the input field.

How it works: on the submit of the form loops over the form fields and validates each field. When a field is invalid, creates the error message element and adds the appropriate css classes to style it. Otherwise, if the field is valid and there is an error message in the markup, then removes it.

<form mbsc-form id="myForm">
    <div class="mbsc-form-group">
        <div class="mbsc-form-group-title">Sign In</div>
        <label>
            <input mbsc-input name="email" type="email" placeholder="Email" required>
        </label>
        <label>
            <input mbsc-input name="password" type="password" placeholder="Password" minlength="6" required>
        </label>
    </div>
    <div class="mbsc-form-group mbsc-btn-group-block">
        <button mbsc-button type="submit">Sign in</button>
    </div>
</form>

var form = document.getElementById("myForm");

form.noValidate = true; // disable HTML5 validation
form.onsubmit = validateForm; // validate form on submit

// loops through the form elements and validates each field
function validateForm(event) {
    event.preventDefault();
    var formValid = true;
    for (f = 0; f < form.elements.length; f++) {
        var field = form.elements[f],
            error = validateField(field);
        formValid = formValid && !error;
        if (error === null) {
            clearErrorState(field);
        } else {
            addErrorState(field, error);
        }
    }
    return formValid;
}

// checks if a field is valid, and returns the error message
function validateField(field) {
    var name = field.name.charAt(0).toUpperCase() + field.name.slice(1),
        firstError = null,
        errorMap = {
            'tooShort': ' is too short.',
            'typeMismatch': ' is invalid.',
            'valueMissing': ' is required.',
        };
    if (field.validity.valid) {
        return null;
    } else {
        for (var key in field.validity) {
            if (!firstError && key !== 'valid' && field.validity[key]) {
                firstError = key;
            }
        }
        var error = errorMap[firstError] ? errorMap[firstError] : ' is invalid.';
        return name + error;
    }
}

// clears a field of the error state and removes the error message
function clearErrorState(field) {
    var parent = field.parentNode,
        errorMsg = parent.querySelector('.mbsc-err-msg');

    parent.parentNode.classList.remove('mbsc-err');
    if (errorMsg) {
        parent.removeChild(errorMsg);
    }
}

// set the field as invalid and shows the error message
function addErrorState(field, message) {
    var parent = field.parentNode,
        errorMsg = parent.querySelector('.mbsc-err-msg');

    if (!errorMsg) {
        errorMsg = document.createElement('span');
        errorMsg.className = 'mbsc-err-msg';
        parent.appendChild(errorMsg);
    }
    errorMsg.innerHTML = message;
}

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:

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.

Global variables

These variables are applied to all base themes: iOS, material, windows and mobiscroll.
They all come in pairs. One for the light and one for the dark variant in each theme.

Variables specific to individual form components can be found on the links below:

• Input, Password, Textarea
• Dropdown
• Checkbox
• Switch
• Radio buttons
• Button
• Slider
• Progress
• Segmented
• Stepper
• Rating
• FormGroup
• Alerts

If you really want to get sophisticated or if a color doesn't look good on a specific theme and you want to overwrite it, you can fine tune all of the above variables individually for each theme. Below are the complete list of variables broken down to themes:

iOS theme

iOS Dark theme

Windows theme

Windows Dark theme

Material theme

Material Dark theme

Mobiscroll theme

Mobiscroll Dark theme

Groups

For styling the groups inside the form element you can use the mbsc-form-group, mbsc-form-group-title and mbsc-form-group-inset classes.

<div class="mbsc-form-group">
	<div class="mbsc-form-group-title">Phone</div>
	<label>
		Home
		<input mbsc-input type="tel" class="md-phone" placeholder="Phone" name="phone" value="+12225550127">
	</label>
	<label>
		Work
		<input mbsc-input type="tel" class="md-phone" placeholder="Phone" name="phone" value="+12225550128">
	</label>
</div>

<div class="mbsc-form-group-inset">
	<label>
		<input mbsc-input id="email" type="email" name="Email" placeholder="Email" />
	</label>
	<label>
		<input mbsc-input name="password" type="text" placeholder="Password" data-password-toggle="true" data-icon="none" data-icon-align="right" />
	</label>
</div>	

Attributes

Methods

Groups theming

Global variables of the Groups

Below you will find a list of SASS variables that affect the Groups:

If you really want to get sophisticated or if a color doesn't look good on a specific theme and you want to overwrite it, you can fine tune all of the above variables individually for each theme. Below are the complete list of variables broken down to themes:

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:

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:

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:

Mobiscroll theme

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

Mobiscroll Dark theme

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

If you are looking for the generic Form variables and how they affect the form in general, check out the tables and pictures here.