@addapptables/perfect-scrollbar
Version:
Perfect scrollbar library for angular
63 lines (53 loc) • 1.53 kB
Markdown
# ADDAPPTABLES Perfect-scrollbar
Utility for scroll browser
## Getting Started
To get started, let's install the package through npm:
Choose the version corresponding to your Angular version:
Angular | /perfect-scrollbar
----------- | -------------------
8 | 2.x
7 | 1.x
```
npm i /perfect-scrollbar perfect-scrollbar --S
```
## How to use
Import AddapptablePerfectScrollbarModule in your module
```javascript
import { AddapptablePerfectScrollbarModule } from '@addapptables/perfect-scrollbar';
({
imports: [AddapptablePerfectScrollbarModule]
})
export class AddapptableModule { }
```
```css
.menu-scroll-container{
position: relative; //this property is important
}
```
```html
<div addapptablesPerfectScrollbar class="menu-scroll-container">
...large content
</div>
```
Options
```javascript
export interface Options {
handlers?: string[];
maxScrollbarLength?: number;
minScrollbarLength?: number;
scrollingThreshold?: number;
scrollXMarginOffset?: number;
scrollYMarginOffset?: number;
suppressScrollX?: boolean;
suppressScrollY?: boolean;
swipeEasing?: boolean;
useBothWheelAxes?: boolean;
wheelPropagation?: boolean;
wheelSpeed?: number;
}
```
```html
<div addapptablesPerfectScrollbar [perfectScrollOptions]="{ wheelPropagation: true }" class="menu-scroll-container">
...large content
</div>
```