Angular wrapper of Malihu's jQuery Custom Scrollbar
Clone or download
iominh Merge pull request #48 from natete/master
Add scrollTo parameter
Latest commit 4d952f9 Oct 6, 2016

readme.md

Readme

This is a set of customized scrollbars for AngularJS that allows you to apply consistent styles and behavior across different browsers (including Firefox) that's built around Malihu's jQuery Custom Scrollbar by Manos Malihutsakis. It provides an AngularJS directive with universal configuration or individual scrollbar configuration.

Demos

Primary Demo

http://iominh.github.io/ng-scrollbars/

The demo code is available on the gh-pages branch if you want to check that out too.

Basic Demo

http://iominh.github.io/ng-scrollbars/demo1.html

Growing scrollbar container

http://iominh.github.io/ng-scrollbars/demo2_expanding_content.html

Updating Scrollbar Demo

http://iominh.github.io/ng-scrollbars/18_update_scrollbars.html

Demo with Angular Material

http://iominh.github.io/ng-scrollbars/10.html

Usage

  1. Add ng-scrollbars and its dependencies to your main file (index.html) This can be downloaded by

In your web page:

<link rel="stylesheet" href="bower_components/malihu-custom-scrollbar-plugin/jquery.mCustomScrollbar.min.css" type="text/css"/>
<script src="bower_components/jquery/dist/jquery.min.js"></script>
<script src="bower_components/angular/angular.min.js"></script>
<script src="bower_components/malihu-custom-scrollbar-plugin/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="bower_components/ng-scrollbars/dist/scrollbars.min.js"></script>
  1. Set ngScrollbars as a dependency in your module
var app = angular.module('app', ['ngScrollbars'])
  1. Add ng-scrollbar directive to any elements:
<div ng-scrollbars ng-scrollbars-config="config"> .... </div>
  1. Specify the configuration as an object visible within the directive's scope:

    4a. For example, the 'config' object referenced in step 3 could be configured like the following:

    $scope.config = {
    	autoHideScrollbar: false,
    	theme: 'light',
    	advanced:{
    		updateOnContentResize: true
    	},
    		setHeight: 200,
    		scrollInertia: 0
    	}
    }

    4b. Some system-wide settings, such as enabling the buttons, can also be set by configuring the ScrollBarsProvider that's included in the ngScrollbars module as referenced in step 2:

    var app = angular.module('app', ['ngScrollbars']);
    app.config(function (ScrollBarsProvider) {
    	ScrollBarsProvider.defaults = {
    		scrollButtons: {
    		    scrollAmount: 'auto', // scroll amount when button pressed
    			enable: true // enable scrolling buttons by default
    		},
    		axis: 'yx' // enable 2 axis scrollbars by default
    	};
    });

    4c. System-wide defaults can also be specified. However, these settings are overridden by any scope level configuration as shown in 4a. For example:

    var app = angular.module('app', ['ngScrollbars']);
    app.config(function (ScrollBarsProvider) {
    	// the following settings are defined for all scrollbars unless the
    	// scrollbar has local scope configuration
    	ScrollBarsProvider.defaults = {
    		scrollButtons: {
    			scrollAmount: 'auto', // scroll amount when button pressed
    			enable: true // enable scrolling buttons by default
    		},
    		scrollInertia: 400, // adjust however you want
    		axis: 'yx', // enable 2 axis scrollbars by default,
    		theme: 'dark',
    		autoHideScrollbar: true
    	};
    });

All configuration options available to Malihu's scrollbar can be provided through the above configuration. See Malihu's page for more details

Updating Scrollbars

As of 0.0.6, scrollbars can be dynamically updated:

For example:

app.controller('mainCtrl', function ($scope, $timeout) {
    $timeout(function() {
        $scope.updateScrollbar('scrollTo', 10);
    });
});
<div class="container" ng-scrollbars ng-scrollbars-update=updateScrollbar ng-controller="mainCtrl">
	<h1>Title</h1>
	<p>A bunch of content</p>
</div>

See this demo

Other options may include:

  • $scope.updateScrollbar('update', ...). Manually updates the scrollbar
  • $scope.updateScrollbar('disable'). Temporarily disables scrollbar
  • $scope.updateScrollbar('stop'). Stops any running scrolling animations
  • $scope.updateScrollbar('destroy'). Completely removes the scrollbar and returns element to original state

See Malihu's documentation for more information on the available callbacks.

Common Gotchas

If the width for some reason keeps shrinking then make sure you specify the width of the CSS for all children elements where ng-scrollbars is applied.

Here's an example ng-scrollbars use case:

<div class="container" ng-scrollbars>
	<h1>Title</h1>
	<p>A bunch of content</p>
</div>

The CSS may need to structured like the following:

.container {
	width: 250px;
}

.container p, .container h1 {
	width: 210px;
}

This is because Malihu looks at the width of the child elements and adjusts, so the child elements may shrink to 0 width if nothing is specified. Also note the container width is a little wider than its contents width because of the extra scrollbar width.

See this demo

Changelog

0.0.11

Fix so package.json entry points to src/scrollbars.js and not src/main.js

0.0.10

Fixed issue with minified version being out of sync with source

0.0.9 (broken)

Scrollbar configs will now dynamically update on changes. Hopefully should fix a couple of issues that users mentioned (#23, #26)

This version's minified version wasn't updated as reported by @florinbardosi in #27

0.0.8

Ghost release to synchronize bower with npm version numbers

0.0.7

Fix reported issues (#21) by making ng-scrollbars-update attribute optional. It wasn't before...

Error: [$compile:nonassign] Expression 'undefined' used with directive 'ngScrollbars' is non-assignable!

0.0.6 (broken)

Add ng-scrollbars-update attribute to update scrollbars through a method

0.0.5

Fix so by default user can press scrollbar buttons to scroll up or down.

0.0.4

Fix so directive works with ng-strict-di

0.0.3

Updated to allow user to set defaults to all scrollbars through the provider configuration. These defaults are overridden by any scope configuration.

0.0.2

Updated ngScrollbars module to allow for configuration that applies to all scrollbars such as the buttons and horizontal scrollbar support

0.0.1

Initial release with basic directive wrapper around Malihu

History

I needed an AngularJS scrollbar that worked well with a dark theme and was consistently styled across different browsers. I found several Angular scrollbars listed below but in general the styling didn't fit or they were lacking features.

Ultimately I found a Stackoverflow post by JMaylin that inspired me to continue the integration effort he/she started.

Other options

In my search for angularjs scrollbars, I also came across a few others:

License

MIT