-
-
Notifications
You must be signed in to change notification settings - Fork 98
Global Options (legacy)
Murhaf Sousli edited this page Feb 18, 2024
·
1 revision
To set global options for all scrollbar components across the app, provide the token NG_SCROLLBAR_OPTIONS
with your custom options like in the following example:
import { NgScrollbarModule, NG_SCROLLBAR_OPTIONS } from 'ngx-scrollbar';
@NgModule({
imports: [
NgScrollbarModule
],
providers: [
{
provide: NG_SCROLLBAR_OPTIONS,
useValue: {
// ... options
}
}
]
})
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 element. |
trackClass | null | Add custom class to scrollbar track elements. |
thumbClass | null | Add custom class to scrollbar thumbnail elements. |
trackClickScrollDuration | 300 | The smooth scroll duration when a scrollbar is clicked. |
minThumbSize | 20 | The minimum scrollbar thumb size in px. |
scrollAuditTime | 0 | Throttle scroll event in ms. |
windowResizeDebounce | 0 | Debounce interval for detecting changes via window.resize event. |
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. |
autoHeightDisabled | false | Whether to set component height to content height. |
autoWidthDisabled | true | Whether to set component width to content width. |
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