ngx-auto-scroll/README.md

Angular 2+ directive to automatically scroll html container content to the bottom.

# Angular 2+ auto scroll directive

## Installation
npm install ngx-auto-scroll

## Usage

#### In module:

```typescript
import {NgxAutoScrollModule} from "ngx-auto-scroll";

@NgModule({
	...
	imports: [ ..., NgxAutoScrollModule]
	...
})
```

#### In template:

```html
<div ngx-auto-scroll lock-y-offset="10" observe-attributes>
    <div *ngFor="let message of messages">{{ message }}</div>
</div>
```

#### Attributes:

Argument passed to `lock-y-offset` is bottom offset of scroll position in pixels after scroll container stops auto scroll. Default value is 10.

`observe-attributes` (optional, default - false) enable listening on attributes changes for example detect changes in font size.

#### Forcing scroll down

When your DOM element or its parent is hidden auto scroll won't work. There is no simple/pure way to scroll hidden element. The best way is to force scrolling down after the element is shown.

```typescript
import {NgxAutoScroll} from "ngx-auto-scroll";

@Component({
   selector: 'sample',
})
export class SampleComponent {
    @ViewChild(NgxAutoScroll) ngxAutoScroll: NgxAutoScroll;

    public forceScrollDown(): void {
        this.ngxAutoScroll.forceScrollDown();
    }
}
```

## Building
This component is built as an Angular 5 module using `ng-packagr`.

```
npm run ng-build
```

## Publishing
To build and publish this component as an Angular 5 module use
```
npm run ng-publishing
```