-
-
Notifications
You must be signed in to change notification settings - Fork 98
Usage
Murhaf Sousli edited this page Nov 9, 2019
·
27 revisions
NPM
npm i ngx-scrollbar @angular/cdk
Import NgScrollbarModule
in your module
import { NgScrollbarModule } from 'ngx-scrollbar';
@NgModule({
imports: [
NgScrollbarModule
]
})
In your template
<ng-scrollbar>
<!-- content -->
</ng-scrollbar>
Here is a stackblitz
Name | Default value | Description |
---|---|---|
[track] | vertical |
Directions to track horizontal , vertical , all
|
[position] | native |
Invert scrollbar position native ,invertX ,invertY , invertAll
|
[visibility] | native |
Scrollbar visibility native , hover , always
|
[appearance] | compact |
Scrollbar appearance standard , compact . |
[viewClass] | null | Add custom class to the viewport. |
[trackClass] | null | Add custom class to scrollbars' tracks. |
[thumbClass] | null | Add custom class to scrollbars' thumbnails. |
[disabled] | false |
Disable the custom scrollbars and use the native ones instead. |
[trackClickScrollDuration] | 300 | The smooth scroll duration when a scrollbar is clicked. |
[minThumbSize] | 20 | The minimum scrollbar thumb size in px. |
[sensorDebounce] | 0 | Debounce interval for detecting changes via ResizeObserver . |
[sensorDisabled] | false | Whether ResizeObserver is disabled. |
[pointerEventsMethod] | viewport |
The method used to detect scrollbar pointer-events, read more. |
[pointerEventsDisabled] | false | Enable/disable the scrollbar track clicked and thumb dragged events. |
(updated) | - | Output that emits when the scrollbar component is updated. |
Become a sponsor and get your logo on our README on GitHub and the front page of https://ngx-scrollbar.netlify.com/.
Become a backer and get your logo on our README on GitHub.
Latest version (v15)
Addons:
Older version (v13)
- Demo for v13
- Usage
- Styling
- Global Options
- Pointer Events
- Scroll Event
- Updated Event
- Smooth Scroll Functions
- Performance tweak
- Integration
- Reached events