@@ -3,4 +3,69 @@ angular-scroll-pane
33
44AngularJS directive to use jScrollPane https://github.com/vitch/jScrollPane
55
6- ** It's gonna be uploaded on bower soon**
6+ ## How to install
7+
8+ - With bower
9+ - `bower install --save angular-scroll-pane`
10+ - Manually
11+ - `dist/angular-jscrollpane.min.js`
12+
13+ ## What to include
14+
15+ Make sure you are including ` jQuery ` , ` Angular ` and ` jScrollPane ` along with ` angular-scroll-pane ` .
16+
17+ ## How to use this module
18+
19+ ```
20+ angular.module("app", ['ngJScrollPane']);
21+ angular.module("app").controller("MyCtrl", function () {
22+ $scope.paneConfig = {
23+ verticalDragMinHeight: 40
24+ }
25+ });
26+
27+ <html>
28+ <body ng-app="app">
29+ <div ng-controller="MyCtrl">
30+ <div scroll-pane scroll-config="paneConfig" id="myScrollPane">
31+ My content needing a scroll pane
32+ </div>
33+ </div>
34+ </body>
35+ </html>
36+ ```
37+
38+ ** Don't forget to specify an id for your scroll pane, otherwise it won't be working**
39+
40+ ## Contributing
41+
42+ If you wish to contribute, fork this repository.
43+
44+ ` grunt build ` builds the module.
45+
46+ ## License
47+
48+ The MIT License (MIT)
49+
50+ Copyright (c) 2014 Geoffrey Bauduin
51+
52+ Permission is hereby granted, free of charge, to any person obtaining a copy
53+ of this software and associated documentation files (the "Software"), to deal
54+ in the Software without restriction, including without limitation the rights
55+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
56+ copies of the Software, and to permit persons to whom the Software is
57+ furnished to do so, subject to the following conditions:
58+
59+ The above copyright notice and this permission notice shall be included in all
60+ copies or substantial portions of the Software.
61+
62+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
64+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
65+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
66+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
67+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
68+ SOFTWARE.
69+
70+
71+
0 commit comments