Skip to content

Commit ee211b5

Browse files
committed
Added Readme file
1 parent 3056f2a commit ee211b5

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# angular-drag-scroll
1+
# Angular Drag to Scroll
22
Lightweight drag to scroll directive for AngularJS
3+
4+
## Installation
5+
* Bower: ```bower install angular-drag-scroll --save```
6+
* Download: you can just download the files from [Github](https://github.com/jellekralt/angular-drag-scroll/archive/master.zip)
7+
8+
## Usage
9+
* Include ```ng-drag-scroll.js``` in your HTML template:
10+
11+
```html
12+
<script src="angular.js"></script>
13+
<script src="ng-drag-scroll.js"></script>
14+
```
15+
16+
* Add a dependency to the ng-drag-scroll module in your application.
17+
18+
```javascript
19+
angular.module('MyApp', ['ng-drag-scroll']);
20+
```
21+
22+
* Add an attribute to an element with a scrollbar to make the content scrollable
23+
24+
```html
25+
<div drag-scroll>
26+
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit. Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ut gravida lorem. Ut turpis felis, pulvinar a semper sed, adipiscing id dolor. Pellentesque auctor nisi id magna consequat sagittis. Curabitur dapibus enim sit amet elit pharetra tincidunt feugiat nisl imperdiet. Ut convallis libero in urna ultrices accumsan. Donec sed odio eros. Donec viverra mi quis quam pulvinar at malesuada arcu rhoncus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. In rutrum accumsan ultricies. Mauris vitae nisi at sem facilisis semper ac in est.</p>
27+
</div>
28+
```
29+
30+
## Credits / Inspiration
31+
* https://github.com/asvd/dragscroll
32+
33+
## License
34+
MIT: http://jellekralt.mit-license.org/

src/ng-drag-scroll.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
'use strict';
33

44
angular
5-
.module('dragscroll')
5+
.module('ng-drag-scroll')
66
.directive('dragScroll', DragScroll);
77

88
DragScroll.$inject = ['$document', '$window', '$parse'];

0 commit comments

Comments
 (0)