Skip to content

Commit d9fdfea

Browse files
committedMay 15, 2021
Adding version 0.0.3
1 parent 74c8ffc commit d9fdfea

34 files changed

+3994
-3718
lines changed
 

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
examples/* linguist-vendored

‎.gitignore

100644100755
+9-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1-
*.DS_Store
1+
.DS_Store
2+
.idea
3+
.ignore/
4+
.vscode/*
25
bower_components/
3-
/node_modules/
6+
node_modules/
7+
**/node_modules/
8+
package-lock.json
9+
src/fullpage.extensions.js
10+
examples/bug**

‎LICENSE

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright (c) Yoloop SL
2+
3+
This software is protected by applicable copyright laws, including
4+
international treaties, and dual-licensed – depending on whether
5+
your use is intended for or may result in commercial advantage
6+
or monetary compensation (commercial purposes), or not.
7+
8+
MULTISCROLL is available under different licenses depending on
9+
whether it is intended for commercial/government use, or for a
10+
personal or non-profit project.
11+
12+
Read more on licensing alternatives here:
13+
- https://github.com/alvarotrigo/multiScroll.js#license

‎README.md

100644100755
+44-50
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# multiScroll.js
22

33
![preview](https://raw.github.com/alvarotrigo/multiScroll.js/master/examples/imgs/multiscroll.png)
4-
![compatibility](http://alvarotrigo.com/multiScroll/imgs/compatible.gif)
4+
![compatibility](https://alvarotrigo.com/multiScroll/imgs/compatible.gif)
55

66
---
7-
![multiScroll.js version](http://img.shields.io/badge/multiscroll.js-v0.2.2-brightgreen.svg)
8-
[![License](http://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)
7+
![multiScroll.js version](http://img.shields.io/badge/multiscroll.js-v0.2.3-brightgreen.svg)
98
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/alvarotrigo/9.95)
109
   **|**   *3.7Kb gziped*   **|**   *Created by [@imac2](https://twitter.com/imac2)*
1110

12-
- [Live demo](http://alvarotrigo.com/multiScroll/)
11+
- [Live demo](https://alvarotrigo.com/multiScroll/) | [Codepen](https://codepen.io/alvarotrigo/pen/WNpwPLJ)
1312
- [Wordpress theme](https://goo.gl/Xuix30)
14-
- [multiScroll.js Extensions](http://alvarotrigo.com/multiScroll/extensions/)
15-
- [Website post](http://alvarotrigo.com/blog/multiscroll-js-jquery-plugin-to-create-multi-scrolling-sites-with-two-vertical-layouts/)
13+
- [multiScroll.js Extensions](https://alvarotrigo.com/multiScroll/extensions/)
14+
- [Website post](https://alvarotrigo.com/blog/multiscroll-js-jquery-plugin-to-create-multi-scrolling-sites-with-two-vertical-layouts/)
1615
---
1716

1817
A simple plugin to create multi scrolling websites with two vertical scrolling panels.
@@ -21,10 +20,11 @@ A simple plugin to create multi scrolling websites with two vertical scrolling p
2120
Invite me to a coffee
2221
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/es/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=multiScroll%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
2322

24-
Customizations of the plugin available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
23+
Customizations of the plugin available upon request for some reasonable price. <a href="https://alvarotrigo.com/#contact-page">Contact me</a>.
2524

2625
- [Introduction](https://github.com/alvarotrigo/multiscroll.js#introduction)
2726
- [Compatibility](https://github.com/alvarotrigo/multiscroll.js#compatibility)
27+
- [License](https://github.com/alvarotrigo/multiScroll.js#license)
2828
- [Usage](https://github.com/alvarotrigo/multiscroll.js#usage)
2929
- [Creating links to sections](https://github.com/alvarotrigo/multiscroll.js#creating-links-to-sections)
3030
- [State classes added by multiscroll.js](https://github.com/alvarotrigo/multiscroll.js#state-classes-added-by-multiscrolljs)
@@ -36,9 +36,9 @@ Customizations of the plugin available upon request for some reasonable price. <
3636
- [Changelog](https://github.com/alvarotrigo/multiscroll.js#changelog)
3737
- [Build tasks](https://github.com/alvarotrigo/multiscroll.js#build-tasks)
3838
- [Resources](https://github.com/alvarotrigo/multiscroll.js#resources)
39+
- [Related projects](https://github.com/alvarotrigo/multiscroll.js#related-projects)
3940
- [Who is using multiscroll.js](https://github.com/alvarotrigo/multiscroll.js#who-is-using-multiscrolljs)
4041
- [Donations](https://github.com/alvarotrigo/multiscroll.js#donations)
41-
- [License](https://github.com/alvarotrigo/multiscroll.js#license)
4242

4343
## Introduction
4444
This plugin its in Beta version. Suggestion are more than welcome, not only for feature requests but also for coding style improvements.
@@ -48,6 +48,18 @@ multiScroll.js is fully functional on all modern browsers, as well as some old o
4848
It works with browsers with CSS3 support and with the ones who don't have it, making it ideal for old browsers compatibility.
4949
It is designed to work as well on touch devices such as mobile phones or tablets.
5050

51+
## License
52+
53+
### Commercial license
54+
If you want to use multiScroll.js to develop commercial websites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Which means, you won't have to change your whole application source code to an open source license. [[Purchase a multiScroll.js Commercial License]](https://alvarotrigo.com/multiScroll/pricing/)
55+
56+
### Non commercial license
57+
If you are creating non commercial pages, you can use it without a license. Bare in mind all companies websites are considered commercial, ncluding non profit organisations websites.
58+
59+
**The credit comments in the JavaScript and CSS files should be kept intact** (even after combination or minification)
60+
61+
[Read more about multiScroll's license](https://alvarotrigo.com/multiScroll/pricing/).
62+
5163
## Usage
5264
As you can see in the example files, you will need to include the JavaScript file `jquery.multiscroll.js` (or the minified version `jquery.multiscroll.min.js`) and the css file `jquery.multiscroll.css` of the plugin, as well as [jQuery](http://jquery.com/). Optionally, you can add the [jQuery UI library](http://jqueryui.com/) 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](http://jqueryui.com/) or the customized version which is included in the vendors folder under the name `jquery.easings.min.js`.)
5365

@@ -68,16 +80,17 @@ npm install multiscroll.js
6880

6981
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
7082

71-
<!-- This following line is needed in case of using the default easing option or when using another
72-
one rather than "linear" or "swing". You can also add the full jQuery UI instead of this file if you prefer -->
83+
<!-- This following line is needed in case of using the multiScroll option css3:false and using a non default value for the option `easingcss3`. You can also add the full jQuery UI instead of this file if you prefer -->
7384
<script src="vendors/jquery.easings.min.js"></script>
7485

7586
<script type="text/javascript" src="jquery.multiscroll.js"></script>
7687
```
7788

7889
### Optional use of CDN
79-
If you prefer to use a CDN to load the needed files, multiscroll.js is in CDNJS:
80-
https://cdnjs.com/libraries/multiscroll.js
90+
If you prefer to use a CDN to load the needed files, multiscroll.js is in CDNJS and others:
91+
- https://cdnjs.com/libraries/multiscroll.js
92+
- https://unpkg.com/multiscroll.js
93+
8194

8295
### Required HTML structure
8396
Each section will be defined with a `div` containing the `section` class.
@@ -120,6 +133,7 @@ $(document).ready(function() {
120133
verticalCentered : true,
121134
scrollingSpeed: 700,
122135
easing: 'easeInQuart',
136+
easingcss3: 'ease-out',
123137
menu: false,
124138
sectionsColor: [],
125139
navigation: false,
@@ -171,11 +185,11 @@ multiScroll.js adds multiple classes in different elements to keep a record of t
171185

172186
- `active` is added the current visible section.
173187
- `active` is added to the current menu element (if using the `menu` option).
174-
- A class of the form `ms-viewing-SECTION` is added to the `body` element of the site. (eg: [`ms-viewing-second`](http://alvarotrigo.com/multiScroll/#second) The `SECTION` part will be the anchors (or index if no anchor is provided) of the current section.
188+
- A class of the form `ms-viewing-SECTION` is added to the `body` element of the site. (eg: [`ms-viewing-second`](https://alvarotrigo.com/multiScroll/#second) The `SECTION` part will be the anchors (or index if no anchor is provided) of the current section.
175189
- `ms-responsive` is added to the `body` element when the entering in the responsive mode
176190

177191
### Use extensions
178-
multiscroll.js [provides a set of extensions](http://alvarotrigo.com/multiScroll/extensions/) you can use to enhance its default features. All of them are listed as [multiscroll.js options](https://github.com/alvarotrigo/multiscroll.js#options).
192+
multiscroll.js [provides a set of extensions](https://alvarotrigo.com/multiScroll/extensions/) you can use to enhance its default features. All of them are listed as [multiscroll.js options](https://github.com/alvarotrigo/multiscroll.js#options).
179193

180194
Extensions requires you to use the minified file [`jquery.multiscroll.extensions.min.js`](https://github.com/alvarotrigo/multiscroll.js/blob/master/dist/jquery.multiscroll.extensions.min.js) that is inside the [`dist` folder](https://github.com/alvarotrigo/multiscroll.js/tree/master/dist) instead of the usual multiscroll.js file (`jquery.multiscroll.js` or `jquery.multiscroll.min.js`).
181195

@@ -192,6 +206,14 @@ Then you will be able to use and configure them as explained in [options](https:
192206

193207
## Options
194208

209+
- `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](https://github.com/alvarotrigo/multiscroll.js#license) and [on the website](https://alvarotrigo.com/multiScroll/pricing/). For example:
210+
211+
```javascript
212+
$('#multiscroll').multiscroll({
213+
licenseKey: 'YOUR_KEY_HERE'
214+
});
215+
```
216+
195217
- `verticalCentered`: (default `true`) Vertically centering of the content within sections.
196218

197219
- `scrollingSpeed`: (default `700`) Speed in milliseconds for the scrolling transitions.
@@ -221,7 +243,7 @@ It requires the file `vendors/jquery.easings.min.js` or [jQuery UI](http://jquer
221243

222244
- `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'`)
223245

224-
- `scrollOverflow`: (default `false`) [Demo](https://alvarotrigo.com/multiScroll/extensions/scrollOverflow.html) | [Extension of multiScroll.js](http://alvarotrigo.com/multiScroll/extensions/). (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.
246+
- `scrollOverflow`: (default `false`) [Demo](https://alvarotrigo.com/multiScroll/extensions/scrollOverflow.html) | [Extension of multiScroll.js](https://alvarotrigo.com/multiScroll/extensions/). (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.
225247

226248
- `scrollOverflowOptions`: (default `null`) when using `scrollOverflow:true` multiScroll.js will make use of a forked and modified version of [iScroll.js library](https://github.com/cubiq/iscroll/). You can customize the scrolling behaviour by providing multiScroll.js with the iScroll.js options you want to use. Check its [documentation](http://iscrolljs.com/) for more info.
227249

@@ -263,7 +285,7 @@ $('#multiscroll').multiscroll({
263285

264286
- `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.
265287

266-
- `responsiveExpand`: (default `false`) [Demo](https://alvarotrigo.com/multiScroll/extensions/responsive-expand.html) | [Extension of multiScroll.js](http://alvarotrigo.com/multiScroll/extensions/). 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.](https://github.com/alvarotrigo/multiscroll.js/wiki/Responsive-Expand-Extension)
288+
- `responsiveExpand`: (default `false`) [Demo](https://alvarotrigo.com/multiScroll/extensions/responsive-expand.html) | [Extension of multiScroll.js](https://alvarotrigo.com/multiScroll/extensions/). 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.](https://github.com/alvarotrigo/multiscroll.js/wiki/Responsive-Expand-Extension)
267289

268290
## Methods
269291

@@ -419,57 +441,29 @@ Want to build multiscroll.js distribution files? Please see [Build Tasks](https:
419441

420442
## Resources
421443
- [Wordpress theme](https://goo.gl/kaTYZb)
444+
- [CSS Easing Animation Tool - Matthew Lein](https://matthewlein.com/tools/ceaser) (useful to define the easing value)
445+
446+
## Related projects
447+
- [fullPage.js](https://alvarotrigo.com/fullPage/)
448+
- [pagePiling.js](https://alvarotrigo.com/pagePiling/)
422449

423450
## Who is using multiscroll.js
424451
If you want your page to be listed here. Please <a href="mailto:alvaro@alvarotrigo.com">contact me</a> with the URL.
425452

426453
- [Themify](https://goo.gl/kaTYZb)
427454
- http://designova.net/reflex/index07.html
428455
- https://www.genscher.com
429-
- http://betterhr.de
430456
- https://www.kurasino.co.jp
431-
- http://www.lhaulhaumaria.com
432-
- https://thewastedhour.com
433-
- http://restaurant-eveil.com
434457
- https://www.tischlerei-clemens.de/tischlerei.html
435458
- http://www.ateliers-romeo.com
436459
- https://buerobinder.de
437460
- https://www.blancacre.com
438-
- http://caporasosrls.com
439461
- https://www.epic.ch/de/home
440462
- https://www.paulsbuero.com
441-
- http://ruiferraodev.net
442463
- http://lucasfleischer.com
443-
- https://quintushortus.com/pages/le-concept
444464

445465

446466
## Donations
447467
Donations would be more than welcome :)
448468

449-
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/es/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=multiScroll%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
450-
451-
452-
## License
453-
454-
(The MIT License)
455-
456-
Copyright (c) 2013 Alvaro Trigo &lt;alvaro@alvarotrigo.com&gt;
457-
458-
Permission is hereby granted, free of charge, to any person obtaining
459-
a copy of this software and associated documentation files (the
460-
'Software'), to deal in the Software without restriction, including
461-
without limitation the rights to use, copy, modify, merge, publish,
462-
distribute, sublicense, and/or sell copies of the Software, and to
463-
permit persons to whom the Software is furnished to do so, subject to
464-
the following conditions:
465-
466-
The above copyright notice and this permission notice shall be
467-
included in all copies or substantial portions of the Software.
468-
469-
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
470-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
471-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
472-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
473-
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
474-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
475-
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
469+
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/es/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=multiScroll%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)

‎bower.json

100644100755
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "multiscroll.js",
3-
"version": "0.2.2",
3+
"version": "0.2.3",
44
"homepage": "http://alvarotrigo.com/multiScroll/",
55
"authors": [
66
"Alvaro Trigo https://github.com/alvarotrigo"

‎dist/jquery.multiscroll.css

100644100755
+10-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
/*!
2-
* multiscroll.js 0.2.2
2+
* multiscroll.js 0.2.3
33
* https://github.com/alvarotrigo/multiscroll.js
4-
* @license MIT licensed
54
*
6-
* Copyright (C) 2016 alvarotrigo.com - A project by Alvaro Trigo
5+
* @license
6+
* Get a multiScroll.js Commercial License for commercial use
7+
* https://alvarotrigo.com/multiScroll/pricing/
8+
*
9+
* Copyright (C) 2018 http://alvarotrigo.com/multiScroll/ - A project by Alvaro Trigo
710
*/
811
html, body {
912
margin: 0;
@@ -33,6 +36,10 @@ html, body {
3336
-o-transition: all 0.7s ease-out;
3437
transition: all 0.7s ease-out;
3538
}
39+
.ms-notransition {
40+
-webkit-transition: none !important;
41+
transition: none !important;
42+
}
3643
#multiscroll-nav {
3744
position: fixed;
3845
z-index: 100;

‎dist/jquery.multiscroll.extensions.min.js

100644100755
File mode changed.

0 commit comments

Comments
 (0)
Please sign in to comment.