You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
48
48
It works with browsers with CSS3 support and with the ones who don't have it, making it ideal for old browsers compatibility.
49
49
It is designed to work as well on touch devices such as mobile phones or tablets.
50
50
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
+
51
63
## Usage
52
64
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`.)
<!-- 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 -->
@@ -171,11 +185,11 @@ multiScroll.js adds multiple classes in different elements to keep a record of t
171
185
172
186
-`active` is added the current visible section.
173
187
-`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.
175
189
-`ms-responsive` is added to the `body` element when the entering in the responsive mode
176
190
177
191
### 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).
179
193
180
194
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`).
181
195
@@ -192,6 +206,14 @@ Then you will be able to use and configure them as explained in [options](https:
192
206
193
207
## Options
194
208
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
+
195
217
-`verticalCentered`: (default `true`) Vertically centering of the content within sections.
196
218
197
219
-`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
221
243
222
244
-`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'`)
223
245
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.
225
247
226
248
-`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.
-`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.
265
287
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)
267
289
268
290
## Methods
269
291
@@ -419,57 +441,29 @@ Want to build multiscroll.js distribution files? Please see [Build Tasks](https:
419
441
420
442
## Resources
421
443
-[Wordpress theme](https://goo.gl/kaTYZb)
444
+
-[CSS Easing Animation Tool - Matthew Lein](https://matthewlein.com/tools/ceaser) (useful to define the easing value)
0 commit comments