Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,37 @@ Include the angular-perfect-scrollbar files in your index.html:
<script src="bower_components/angular-perfect-scrollbar/src/angular-perfect-scrollbar.js"></script>
```

---

Install via NPM:

```shell
$ npm install angular-perfect-scrollbar perfect-scrollbar --save
```

Import angular-perfect-scrollbar in your JavaScript:

```js
import 'angular-perfect-scrollbar';
```

Include perfect-scrollbar CSS, for instance with Webpack import it from within a JS or SCSS file:

```js
import 'perfect-scrollbar/css/perfect-scrollbar.css';
```

When using Webpack, the `angular` and `PerfectScrollbar` globals must be provided with the ProvidePlugin:

```js
plugins: [
new webpack.ProvidePlugin({
'angular': 'angular',
'PerfectScrollbar': ['perfect-scrollbar', 'default']
})
]
```

Usage
-----

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{
"name": "angular-perfect-scrollbar",
"version": "0.2.0",
"version": "0.2.1",
"private": false,
"main": "src/angular-perfect-scrollbar.js",
"scripts": {
"test": "grunt"
},
"dependencies": {},
"peerDependencies": {
"perfect-scrollbar": "^1.3.0"
},
"devDependencies": {
"grunt": "^0.4.2",
"grunt-contrib-jshint": "^0.8.0",
Expand Down