Initial Scrollerrt.js commit

Author: HarmenM

.gitignore

@@ -0,0 +1,3 @@
+*.idea
+typings
+node_modules

README.md

@@ -1,2 +1,109 @@
-# scrollert
-Scrollert - Cross browser OSX-like scrollbar jQuery plugin
+# Scrollert.js - a cross browser, OSX-like, light weight scrollbar
+Scrollert.js is a jQuery plugin that implements uniform scrollbars on all browsers, platforms and devices. It has a small memory and DOM footprint in the browser and is fully customizable through CSS. It creates both **horizontal** and **vertical** scrollbars. 
+
+Scrollert.js can be loaded as a [UMD module](https://github.com/umdjs/umd) with your Module loader of choice (SystemJS, RequireJS, Webpack etc) or by loading it globally with a `<script>` tag.
+
+Scrollert.js.js is written in Typescript and LESS.
+
+# Support and compatibility
+Scrollert.js is thoroughly field tested and is compatible with:
+- *Chrome* (Windows, OSX, Linux)
+- *Internet Explorer 9+*
+- *Microsoft Edge*
+- *Firefox* (Windows, OSX, Linux)
+- *Opera* (Windows, OSX, Linx)
+
+# Basic usage
+Embed the `scrollert.min.js` and `scrollert.min.css` in your HTML page.
+```html
+<div class="scrollert">
+	<div class="scrollert-content" tabindex="1">
+		{your content here}
+	</div>
+</div>
+
+<!-- Somewhere below before body close -->
+<script type="application/javascript">
+	$('.scrollert').scrollert();
+</script>
+```
+
+# Advanced usage
+## Options
+It is possible to bootstrap a Scrollert.js instance with the following options:
+
+```javascript
+jQuery('.scrollert').scrollert({
+	axes: ['y'], 
+	'preventOuterScroll': true
+});
+```
+### axes 
+Specify to which axis or axes Scrollert.js must listen. Gives horizontal and/or vertical scrollbars.
+
+
+**Type:** array
+
+**Default:** `['x', 'y']`
+
+### preventOuterScroll
+Prevents scrolling of parent elements while hovering a scrollert pane.
+
+**Type:** boolean
+
+**Default:** `false`
+
+### cssPrefix
+The prefix which is prepended to all css-classes.
+
+
+**Type:** string
+
+**Default:** `scrollert`
+
+### eventNamespace
+The namespace in which all events are added. There is not really a use case to override this, but it is still possible though.
+
+
+**Type:** string
+
+**Default:** `scrollert`
+
+### contentSelector
+Specify a custom content selector. By default the cssPrefix option is used to get the content child out of Scroller's container element. (Default: `.scrollert-content`). If you want to use a custom selector for your content element, you can specify the selector to let Scrollert.js know where to look for the content element. The selector must be a valid `jQuery/sizzle` selector.
+
+
+**Type:** string
+
+**Default:** `null`
+
+## Methods
+The following methods can be called after scrollert is initialized:
+
+### update
+To update the scrollbars. This is necessary when the dimensions of the `content element` are changed due to DOM or changes. 
+```javascript
+jQuery('.scrollert').scrollert('update');
+```
+### destroy
+To destroy a Scrollert.js instance and revert all changes back to how it was before scrollert was initialized.
+```javascript
+jQuery('.scrollert').scrollert('destroy');
+```
+
+## Events
+Not implemented yet.
+
+# FAQ
+<sup>frequently asked and less frequently asked, but still answered:</sup>
+## How do I customize Scrollert.js?
+You can customize the looks of Scrollert.js by styling it using CSS.
+
+## Why must I specify a tabindex on the content element?
+Good question. I forgot while developing. There really is a reason for that. When it comes to mind, I will update this question
+
+## Why is this plugin created? There are already so many javascript scrollbar plugins
+Syslogic is the maker of Scienta. The majority of our customers uses Windows. There was only one problem. Although we like windows, we are not quite fond of the default Windows scrollbar, especially not when used in an inline panel. To provide our customers with a beautiful and uniform scrolling experience, we searched for a scrollbar solution. We couldn't find one that suited our needs. So we decided to build one ourselfs.
+ 
+ # Build it yourself
+ You don't have to stick to the shipped build. Why not build it yourself? You can run `npm install` and `gulp build` to create a customized build.

build/typescript/jquery-umd.js

@@ -0,0 +1,29 @@
+(function (factory) {
+	if (typeof define === 'function' && define.amd) {
+		// AMD. Register as an anonymous module.
+		define(['jquery'], factory);
+	} else if (typeof module === 'object' && module.exports) {
+		// Node/CommonJS
+		module.exports = function( root, jQuery ) {
+			if ( jQuery === undefined ) {
+				// require('jQuery') returns a factory that requires window to
+				// build a jQuery instance, we normalize how we use modules
+				// that require this pattern but the window provided is a noop
+				// if it's defined (how jquery works)
+				if ( typeof window !== 'undefined' ) {
+					jQuery = require('jquery');
+				}
+				else {
+					jQuery = require('jquery')(root);
+				}
+			}
+			factory(jQuery);
+			return jQuery;
+		};
+	} else {
+		// Browser globals
+		factory(jQuery);
+	}
+}(function (jQuery) {
+	/** {CODE} */
+}));