A simple plugin to create split scrolling websites with two vertical scrolling panels.
npm install multiscroll.jsjquery.multiscroll.js (or the minified version jquery.multiscroll.min.js) and the css file jquery.multiscroll.css of the plugin, as well as jQuery. Optionally, you can add the jQuery UI library in case you want to use other easing effects apart from the ones included in the jQuery library which are the linear or swing effects. (easeInQuart is active by default, so you would need jQuery UI library or the customized version which is included in the vendors folder under the name jquery.easings.min.js.)
shell
// With bower
bower install multiscroll.js
// With npm
npm install multiscroll.js
`
$3
`html
`
$3
If you prefer to use a CDN to load the needed files, multiscroll.js is in CDNJS and others:
- https://cdnjs.com/libraries/multiscroll.js
- https://unpkg.com/multiscroll.js
$3
Each section will be defined with a div containing the section class.
The active section by default will be the first section, which is taken as the home page.
`html
Some section
Some section
Some section
Some section
Some section
Some section
`
If you want to define a different starting point rather than the first section, just add the class active to the section you want to show on load.
This should be done for the ms-right and ms-left elements.
`javascript
Some section
`
$3
All you need to do is call the plugin inside a $(document).ready function:
`javascript
$(document).ready(function() {
$('#multiscroll').multiscroll();
});
`
A more complex initialization with all options set could look like this:
`javascript
$(document).ready(function() {
$('#multiscroll').multiscroll({
verticalCentered : true,
scrollingSpeed: 700,
easing: 'easeInQuart',
easingcss3: 'ease-out',
menu: false,
sectionsColor: [],
navigation: false,
navigationPosition: 'right',
navigationColor: '#000',
navigationTooltips: [],
loopBottom: false,
loopTop: false,
css3: false,
paddingTop: 0,
paddingBottom: 0,
normalScrollElements: null,
scrollOverflow: false,
scrollOverflowOptions: null,
keyboardScrolling: true,
touchSensitivity: 5,
//responsive
responsiveWidth: 0,
responsiveHeight: 0,
responsiveExpand: false,
// Custom selectors
sectionSelector: '.ms-section',
leftSelector: '.ms-left',
rightSelector: '.ms-right',
//events
onLeave: function(index, nextIndex, direction){},
afterLoad: function(anchorLink, index){},
afterRender: function(){},
afterResize: function(){},
});
});
`
$3
If you are using multiscroll.js with anchor links for the sections (using the anchors option), then you will be able to use anchor links also to navigate directly to a certain section by using the URL.
You can do it by creating accessing to the URL by adding the anchor. For example: http://youriste.com/#secondSection.
Be careful! data-anchor tags can not have the same value as any ID element on the site (or NAME element for IE).
You can also use the menu option and make use of anchor links (#) as explained below in the options section.
$3
multiScroll.js adds multiple classes in different elements to keep a record of the status of the site:
- active is added the current visible section.
- active is added to the current menu element (if using the menu option).
- A class of the form ms-viewing-SECTION is added to the body element of the site. (eg: ms-viewing-second The SECTION part will be the anchors (or index if no anchor is provided) of the current section.
- ms-responsive is added to the body element when the entering in the responsive mode
$3
multiscroll.js provides a set of extensions you can use to enhance its default features. All of them are listed as multiscroll.js options.
Extensions requires you to use the minified file jquery.multiscroll.extensions.min.js that is inside the dist folder instead of the usual multiscroll.js file (jquery.multiscroll.js or jquery.multiscroll.min.js).
Once you adquire the extension file, you will need to add it before multiscroll. For example, if I want to use the Continuos Horizontal extension, I would have include the extension file and then the extensions version of the multiscroll file.
`html
`
An activation key and a license key will be required for each extension. See more details about it here.
Then you will be able to use and configure them as explained in options.
Options
- licenseKey: (default null). This option is compulsory. If you use multiScroll in any kind of commercial project, then you should use the license key provided on the purchase of the multiScroll.js Commercial License. Please read more about licenses here and on the website. For example:
`javascript
$('#multiscroll').multiscroll({
licenseKey: 'YOUR_KEY_HERE'
});
`
- verticalCentered: (default true) Vertically centering of the content within sections.
- scrollingSpeed: (default 700) Speed in milliseconds for the scrolling transitions.
- sectionsColor:(default none) Define the CSS background-color property for each section:
Example:
`javascript
$('#multiscroll').multiscroll({
sectionsColor: ['#f2f2f2', '#4BBFC3', '#7BAABE', 'whitesmoke', '#000'],
});
`
- anchors: (default []) Defines the anchor links (#example) to be shown on the URL for each section. Using anchors forward and backward navigation will also be possible through the browser. This option also allows users to bookmark a specific section. Be careful! if you use anchors, they can not have the same value as any ID element on the site (or NAME element for IE).
- easing: (default easeInQuart) Defines the transition effect to use for the vertical and horizontal scrolling.
It requires the file vendors/jquery.easings.min.js or jQuery UI for using some of its transitions. Other libraries could be used instead.
- loopTop: (default false) Defines whether scrolling up in the first section should scroll to the last one or not.
- loopBottom: (default false) Defines whether scrolling down in the last section should scroll to the first one or not.
- css3: (default false). Defines wheter to use JavaScript or CSS3 transforms to scroll within sections. Useful to speed up the movement in tablet and mobile devices with browsers supporting CSS3. If this option is set to true and the browser doesn't support CSS3, a jQuery fallback will be used instead.
- paddingTop: (default 0) Defines the top padding for each section with a numerical value and its measure (paddingTop: '10px', paddingTop: '10em'...) Useful in case of using a fixed header.
- paddingBottom: (default 0) Defines the bottom padding for each section with a numerical value and its measure (paddingBottom: '10px', paddingBottom: '10em'...). Useful in case of using a fixed footer.
- normalScrollElements: (default null) If you want to avoid the auto scroll when scrolling over some elements, this is the option you need to use. (useful for maps, scrolling divs etc.) It requires a string with the jQuery selectors for those elements. (For example: normalScrollElements: '#element1, .element2')
- scrollOverflow: (default false) Demo | Extension of multiScroll.js. (not compatible with IE 8) defines whether or not to create a scroll bar for the section/slide in case its content is bigger than the viewport's height. When set to true, your content will be wrapped by multiScroll.js. Consider using delegation or load your other scripts in the afterRender callback.
- scrollOverflowOptions: (default null) when using scrollOverflow:true multiScroll.js will make use of a forked and modified version of iScroll.js library. You can customize the scrolling behaviour by providing multiScroll.js with the iScroll.js options you want to use. Check its documentation for more info.
- keyboardScrolling: (default true) Defines if the content can be navigated using the keyboard
- touchSensitivity: (default 5) Defines a percentage of the browsers window width/height, and how far a swipe must measure for navigating to the next section.
- menu: (default false) A selector can be used to specify the menu to link with the sections. This way the scrolling of the sections will activate the corresponding element in the menu using the class active.
This won't generate a menu but will just add the active class to the element in the given menu with the corresponding anchor links.
In order to link the elements of the menu with the sections, an HTML 5 data-tag (data-menuanchor) will be needed to use with the same anchor links as used within the sections. Example:
`html
`
`javascript
$('#multiscroll').multiscroll({
anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],
menu: '#myMenu'
});
`
- navigation: (default false) If set to true, it will show a navigation bar made up of small circles.
- navigationPosition: (default none) It can be set to left or right and defines which position the navigation bar will be shown (if using one).
- navigationTooltips: (default []) Defines the tooltips to show for the navigation circles in case they are being used. Example: navigationTooltips: ['firstSection', 'secondSection'].
- sectionSelector: (default .ms-section) You can use own class name for section.
- leftSelector: (default .ms-left) You can use own class name for left block.
- rightSelector: (default .ms-right) You can use own class name for right block.
- responsiveWidth: (default 0) Only useful when using the option responsiveExpand. Normal scroll will be used under the defined width in pixels. A class ms-responsive is added to the body tag in case the user wants to use it for his own responsive CSS. For example, if set to 900, whenever the browser's width is less than 900 the plugin will scroll like a normal site.
- responsiveHeight: (default 0) Only useful when using the option responsiveExpand. Normal scroll will be used under the defined height in pixels. A class ms-responsive is added to the body tag in case the user wants to use it for his own responsive CSS. For example, if set to 900, whenever the browser's height is less than 900 the plugin will scroll like a normal site.
- responsiveExpand: (default false) Demo | Extension of multiScroll.js. When responsive mode is fired (by using the responsiveWidth or responsiveHeight options detailed above) it turns auto scrolling off and expands each left and right side into a full-width section placing one after another. Then the page can be scrolled normally. Read more about how to use the Responsive Expand option.
Methods
$3
Scrolls one section up:
`javascript
$.fn.multiscroll.moveSectionUp();
`
$3
Scrolls one section down:
`javascript
$.fn.multiscroll.moveSectionDown();
`
$3
Scrolls the page to the given section. The first section parameter can be the index of the section or its anchor link.
`javascript
/Scrolling to the section with the anchor link firstSection /
$.fn.multiscroll.moveTo('firstSection');
`
`javascript
//Scrolling to the 3rd section in the site
$.fn.multiscroll.moveTo(3);
`
$3
Adds or remove the possibility of scrolling through sections by using mouse wheel (which is active by default).
`javascript
$.fn.multiscroll.setMouseWheelScrolling(false);
`
$3
Adds or remove the possibility of scrolling through sections by using the keyboard arrow keys (which is active by default).
`javascript
$.fn.multiscroll.setKeyboardScrolling(false);
`
$3
Defines the scrolling speed in milliseconds.
`javascript
$.fn.multiscroll.setScrollingSpeed(700);
`
$3
Destroy plugin's events.
`javascript
$.fn.multiscroll.destroy();
`
$3
Build plugin's events after destroy.
`javascript
$.fn.multiscroll.build();
`
Callbacks
$3
Callback fired once the sections have been loaded, after the scrolling has ended.
Parameters:
- anchorLink: anchorLink corresponding to the section.
- index: index of the section. Starting from 1.
In case of not having anchorLinks defined in the plugin the index parameter would be the only one to use.
Example:
`javascript
$('#multiscroll').multiscroll({
anchors: ['firstPage', 'secondPage', 'thirdPage', 'fourthPage', 'lastPage'],
afterLoad: function(anchorLink, index){
//using index
if(index == '3'){
alert("Section 3 ended loading");
}
//using anchorLink
if(anchorLink == 'secondSection'){
alert("Section 2 ended loading");
}
}
});
`
$3
This callback is fired once the user leaves a section, in the transition to the new section.
Parameters:
- index: index of the leaving section. Starting from 1.
- nextIndex: index of the destination section. Starting from 1.
- direction: it will take the values up or down depending on the scrolling direction.
Example:
`javascript
$('#multiscroll').multiscroll({
onLeave: function(index, nextIndex, direction){
//after leaving section 2
if(index == '2' && direction =='down'){
alert("Going to section 3!");
}
else if(index == '2' && direction == 'up'){
alert("Going to section 1!");
}
}
});
`
$3
This callback is fired just after the structure of the page is generated. This is the callback you want to use to initialize other plugins or fire any code which requires the document to be ready (as this plugin modifies the DOM to create the resulting structure).
Example:
`javascript
$('#multiscroll').multiscroll({
afterRender: function(){
alert("The resulting DOM structure is ready");
}
});
`
$3
This callback is fired after resizing the browser's window. Just after the sections are resized.
Example:
`javascript
$('#multiscroll').multiscroll({
afterResize: function(){
alert("The sections have finished resizing");
}
});
``