Contents
General Calendar Cards Color Date & Time Event Calendar Forms Image Listview Measurement Navigation Number Numpad Option List Page Range Scroller Scrollview Select Timer Timespan Treelist Widget Tools Accessibility

Page

About

The page component adds basic styling to a container, based on the theme being used, like background and typography. Additionally, if a menustrip is also being used as top and/or bottom navigation, all pages get a top and bottom padding accordingly to accomodate the menustrip without overlapping the content.

Pages are required to be the direct descendants of the body element (or the element specified by the context setting).

Initialization

Auto initialization

To auto-initialize the page elements, simply put the mbsc-page attribute on the container element.

<div id="mypage" mbsc-page>
    <div class="mbsc-padding">
        <h1>Page Title</h1>
        <p>Page content.</p>
    </div>
</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 page initialization.

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

If the page 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 elements inside with the mbsc-page attribute will be initialized (including itself).

$.get('/mypage', function (responseHtml) {
    $(responseHtml).appendTo('body').trigger('mbsc-enhance');
});

Manual Initialization

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

HTML
<div id="mypage">
    <div class="mbsc-padding">
        <h1>Page Title</h1>
        <p>Page content.</p>
    </div>
</div>
Javascript
$(function () {
    $('#mypage').mobiscroll().page({
        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.

$.get('/mypage', function (responseHtml) {
    $('body').append(responseHtml);
    $('#mypage').mobiscroll().page({
        theme: 'material'
    });
});

Options

Name Type Default value Description
context String or HTMLElement 'body' Context in which mobiscroll is appended and positioned (if not inline). Can be a selector string or a DOM element.
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 the theme for the specific platform is not present, it will revert to the Mobiscroll theme.

Supplied themes:
  • 'ios' - new iOS 7, 8, 9 theme
  • 'material' - Material theme (Android 5.x)
  • 'material-dark' - Material dark theme (Android 5.x)
  • 'mobiscroll' - Mobiscroll theme
  • 'mobiscroll-dark' - Mobiscroll Dark theme
  • 'windows' - Windows theme
  • 'windows-dark' - Windows theme (dark version)
It's possible to create custom themes in css by prefixing any css class used in the page markup with the theme name and the 'mbsc' prefix, e.g.: .mbsc-my-theme .dwwr { /* My CSS */ }, and set the theme option to 'my-theme'
Make sure that the theme you set is included in the downloaded package.

Events

Name Description
onInit(event, inst) Triggered when the component is initialized.

Parameters

  • event: Object - The event object.
  • inst: Object - The instance object of the page.

Example

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

Methods

Name Description
getInst() Returns the object instance.

Returns: Object

  • The object instance.

Example

Methods can be called on an instance. For more details see calling methods
// With selector
$('#mobiscroll').mobiscroll('getInst');

// With instance
mobiscrollInstance.getInst();
option(options) Sets one or more options for the component.

Parameters

  • options: Object - A map of option-value pairs to set.

Example

Methods can be called on an instance. For more details see calling methods
// With selector
$('#mobiscroll').mobiscroll('option', {
    display: 'bottom',
    lang: 'de'
});

// With instancee
mobiscrollInstance.option({
    display: 'bottom',
    lang: 'de'
});
tap(el, handler) Attaches the handler function to the tap event of element el.

Parameters

  • el: Object - The element with tap event.
  • handler: Function - If the action was initiated with touch event, handler is called on touchend, otherwise on click.

Example

Methods can be called on an instance. For more details see calling methods
// With selector
$('#mobiscroll').mobiscroll('tap', $('#element'), function () { alert("It's a tap!"); });

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

Localization

Name Type Default value Description
lang String 'en-US' Language of the component. Based on the language string the component loads the language based default settings from the language modules.
Supported languages:
  • 'en' or 'en-US' or undefined - English
  • 'en-UK' or 'en-GB' - English (UK)
  • 'ar' - Arabic
  • 'bg' - Bulgarian
  • 'ca' - Catalan
  • 'cs' - Czech
  • 'zh' - Chinese
  • 'da' - Danish
  • 'de' - German
  • 'el' - Greek
  • 'es' - Spanish
  • 'fa' - Farsi
  • 'fi' - Suomi
  • 'fr' - French
  • 'he' - Hebrew
  • 'hi' - Hindi
  • 'hr' - Croatian
  • 'hu' - Hungarian
  • 'it' - Italian
  • 'ja' - Japanese
  • 'ko' - Korean
  • 'lt' - Lithuanian
  • 'nl' - Dutch
  • 'no' - Norwegian
  • 'pl' - Polish
  • 'pt-BR' - Brazilian Portuguese
  • 'pt-PT' - European Portuguese
  • 'ro' - Romanian
  • 'ru' - Russian
  • 'ru-UA' - Russian (UA)
  • 'sk' - Slovak
  • 'sr' - Serbian
  • 'sv' - Swedish
  • 'tr' - Turkish
  • 'vi' - Vietnamese
rtl Boolean false Right to left display.

Typography

Typography variations can be used to text styling.

Ultra-bold
<p class="mbsc-ultra-bold">This is a paragraph with ultra-bold font-weight </p>
Bold
<p class="mbsc-bold">This is a paragraph with bold font-weight </p>
Medium
<p class="mbsc-medium">This is a paragraph with medium font-weight </p>
Light
<p class="mbsc-light">This is a paragraph with light font-weight </p>
Thin
<p class="mbsc-thin">This is a paragraph with thin font-weight </p>
Italic
<p class="mbsc-italic">This is a paragraph with italic font-style </p>
Padding
<div class="mbsc-padding">This is a section with padding </div>
Left align
<p class="mbsc-align-left">This is a paragraph with text aligned left </p>
Right align
<p class="mbsc-align-right">This is a paragraph with text aligned right </p>
Center align
<p class="mbsc-align-center">This is a paragraph with centered text </p>
Float Left
<p class="mbsc-pull-left">This is a paragraph with text pulled left </p>
Float Right
<p class="mbsc-pull-right">This is a paragraph with text pulled right </p>

Notes

Provide inline feedback messages for typical user actions. The notes include several predefined colors, each serving its own semantic purpose.

For proper styling, use one of the eight required contextual classes (e.g. .mbsc-note-warning).

Predefined note styles
<div class="mbsc-note mbsc-note-primary">This is a primary note!</div>
<div class="mbsc-note mbsc-note-secondary ">This is a secondary note!</div>
<div class="mbsc-note mbsc-note-success ">This is a success note!</div>
<div class="mbsc-note mbsc-note-danger ">This is a danger note!</div>
<div class="mbsc-note mbsc-note-warning ">This is a warning note!</div>
<div class="mbsc-note mbsc-note-info ">This is a info  note!</div>
<div class="mbsc-note mbsc-note-light ">This is a light note!</div>
<div class="mbsc-note mbsc-note-dark ">This is a dark note!</div>

Images & Videos

Optimize your images and videos with the predefined classes.

Avatar images can be applied with the mbsc-avatar class.

Avatar image example
<img class="mbsc-avatar" src="image.png">

Thumbnail images can be applied with the mbsc-thumbnail class.

Thumbnail image example
<img class="mbsc-img-thumbnail" src="image.png">

Full width images and videos can be applied with the mbsc-fluid class

Full width image example
<img class="mbsc-media-fluid" src="picture.png">