# ng2-scrollable

> Angular2 Scrollable Section Detection With Animation

Latest version **0.8.0** (published 2017-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install ng2-scrollable
pnpm add ng2-scrollable
yarn add ng2-scrollable
bun add ng2-scrollable
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.0 |
| Published | 2017-03-04 |
| First published | 2016-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Allen Kim |
| Maintainers | allenkim |
| Keywords | angular2, scrollable, directive |

## Links

- npm: https://www.npmjs.com/package/ng2-scrollable
- Repository: https://github.com/ng2-ui/ng2-scrollable
- Homepage: https://github.com/ng2-ui/ng2-scrollable#readme
- Issues: https://github.com/ng2-ui/ng2-scrollable/issues
- npm.io page: https://npm.io/package/ng2-scrollable

## Dependencies (1)

- [ng2-utils](https://npm.io/package/ng2-utils.md) ^0.5.0

## Recent versions

- 0.8.0 (latest) — 2017-03-04
- 0.7.1 — 2016-12-21
- 0.7.0 — 2016-12-12
- 0.6.3 — 2016-10-24
- 0.6.2 — 2016-10-14
- 0.6.1 — 2016-09-17
- 0.6.0 — 2016-09-11
- 0.5.3 — 2016-08-28
- 0.5.2 — 2016-08-27
- 0.5.1 — 2016-08-03
- 0.5.0 — 2016-08-02
- 0.4.0 — 2016-07-15
- 0.3.0 — 2016-07-14
- 0.2.0 — 2016-07-01
- 0.1.0 — 2016-06-30

## README

# ng2-scrollable
Angular2 Automatic Scroll Detection With Animation


<a href="https://rawgit.com/ng2-ui/ng2-scrollable/master/app/index.html">
  <img src="http://i.imgur.com/9PWnNqe.png" width="50% border="1" />
</a>

Plunker Example: https://plnkr.co/edit/wLVudY?p=preview&open=app.component.ts

## Install

1. install ng2-scrollable

        $ npm install ng2-scrollable --save-dev

2. add `map` and `packages` to your `systemjs.config.js`

        map['ng2-scrollable'] = 'node_modules/ng2-scrollable/dist';
        packages['ng2-scrollable'] = { main: 'ng2-scrollable.umd.js', defaultExtension: 'js' }

3. import Ng2ScrollableModule to your AppModule

        import { Ng2ScrollableModule } from 'ng2-scrollable';
        
        @NgModule({
          imports: [BrowserModule, FormsModule, Ng2ScrollableModule],
          declarations: [AppComponent],
          bootstrap: [ AppComponent ]
        })
        export class AppModule { }


## Usage it in your code

        <ul>
          <li [class.current]="id=='s1'" (click)="scrollable.el.scrollTo('s1')">One
          <li [class.current]="id=='s2'" (click)="scrollable.el.scrollTo('s2')">Two
          <li [class.current]="id=='s3'" (click)="scrollable.el.scrollTo('s3')">Three
          <li [class.current]="id=='s4'" (click)="scrollable.el.scrollTo('s4')">Four
          <li [class.current]="id=='s5'" (click)="scrollable.el.scrollTo('s5')">Five
          <li [class.current]="id=='s6'" (click)="scrollable.el.scrollTo('s6')">Six
          <li [class.current]="id=='s7'" (click)="scrollable.el.scrollTo('s7')">Seven
          <li [class.current]="id=='s8'" (click)="scrollable.el.scrollTo('s8')">Eight
          <li [class.current]="id=='s9'" (click)="scrollable.el.scrollTo('s9')">Nine
        </ul>
        <div class="scrollable" (scrolledTo)="id=$event" ng2-scrollable>
          <div id="s1">One</div>
          <div id="s2">Two</div>
          <div id="s3">Three</div>
          <div id="s4">Four</div>
          <div id="s5">Five</div>
          <div id="s6">Six</div>
          <div id="s7">Seven</div>
          <div id="s8">Eight</div>
          <div id="s9">Nine</div>
        </div>

         
For full example, please check out `test` directory to see the example of;

  - `systemjs.config.js`
  - `app.module.ts`
  -  and `app.component.ts`.

## **ng2-ui** welcomes new members and contributors

This module is only improved and maintained by contributors like you.

As a contributor, it's NOT required to be skilled in Javascript nor Angular2. 
You are only to be open-minded and interested in helping others.
As a contributor, you do following;

  * Updating README.md
  * Improving code comments
  * Answering issues and building FAQ
  * Documentation
  * Translation

In result of your active contribution, you will be listed as a core contributor
on https://ng2-ui.github.io, and a member of ng2-ui too.

If you are interested in becoming a contributor and/or a member of ng-ui,
please send me email to `allenhwkim AT gmail.com` with your github id. 


### LICENSE 
MIT

---
_Source: https://npm.io/package/ng2-scrollable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._