ngx-perfect-scrollbar
- Version 10.1.1
- Published
- 337 kB
- 3 dependencies
- MIT license
Install
npm i ngx-perfect-scrollbaryarn add ngx-perfect-scrollbarpnpm add ngx-perfect-scrollbarOverview
Angular wrapper library for Perfect Scrollbar
Index
Variables
Classes
- PerfectScrollbarDirective- config
- disabled
- elementRef
- geometry()
- ngDoCheck()
- ngOnChanges()
- ngOnDestroy()
- ngOnInit()
- position()
- ps()
- psScrollDown
- psScrollLeft
- psScrollRight
- psScrollUp
- psScrollX
- psScrollY
- psXReachEnd
- psXReachStart
- psYReachEnd
- psYReachStart
- scrollable()
- scrollTo()
- scrollToBottom()
- scrollToElement()
- scrollToLeft()
- scrollToRight()
- scrollToTop()
- scrollToX()
- scrollToY()
- update()
 
Interfaces
Variables
variable PERFECT_SCROLLBAR_CONFIG
const PERFECT_SCROLLBAR_CONFIG: InjectionToken<unknown>;Classes
class Geometry
class Geometry {}constructor
constructor(x: number, y: number, w: number, h: number);property h
h: number;property w
w: number;property x
x: number;property y
y: number;class ɵa
class ForceNativeScrollDirective {}constructor
constructor(renderer: Renderer2, el: ElementRef);class PerfectScrollbarComponent
class PerfectScrollbarComponent implements OnInit, OnDestroy, DoCheck {}constructor
constructor(zone: NgZone, cdRef: ChangeDetectorRef, platformId: Object);property autoPropagation
autoPropagation: boolean;property config
config?: PerfectScrollbarConfigInterface;property directiveRef
directiveRef?: PerfectScrollbarDirective;property disabled
disabled: boolean;property indicatorX
indicatorX: boolean;property indicatorY
indicatorY: boolean;property interaction
interaction: boolean;property psScrollDown
psScrollDown: EventEmitter<any>;property psScrollLeft
psScrollLeft: EventEmitter<any>;property psScrollRight
psScrollRight: EventEmitter<any>;property psScrollUp
psScrollUp: EventEmitter<any>;property psScrollX
psScrollX: EventEmitter<any>;property psScrollY
psScrollY: EventEmitter<any>;property psXReachEnd
psXReachEnd: EventEmitter<any>;property psXReachStart
psXReachStart: EventEmitter<any>;property psYReachEnd
psYReachEnd: EventEmitter<any>;property psYReachStart
psYReachStart: EventEmitter<any>;property scrollIndicators
scrollIndicators: boolean;property states
states: any;property usePSClass
usePSClass: boolean;method ngDoCheck
ngDoCheck: () => void;method ngOnDestroy
ngOnDestroy: () => void;method ngOnInit
ngOnInit: () => void;class PerfectScrollbarConfig
class PerfectScrollbarConfig implements PerfectScrollbarConfigInterface {}constructor
constructor(config?: PerfectScrollbarConfigInterface);property handlers
handlers?: string[];property maxScrollbarLength
maxScrollbarLength?: number;property minScrollbarLength
minScrollbarLength?: number;property scrollingThreshold
scrollingThreshold?: number;property scrollXMarginOffset
scrollXMarginOffset?: number;property scrollYMarginOffset
scrollYMarginOffset?: number;property suppressScrollX
suppressScrollX?: boolean;property suppressScrollY
suppressScrollY?: boolean;property swipeEasing
swipeEasing?: boolean;property useBothWheelAxes
useBothWheelAxes?: boolean;property wheelPropagation
wheelPropagation?: boolean;property wheelSpeed
wheelSpeed?: number;method assign
assign: (config?: PerfectScrollbarConfigInterface) => void;class PerfectScrollbarDirective
class PerfectScrollbarDirective implements OnInit, OnDestroy, DoCheck, OnChanges {}constructor
constructor(    zone: NgZone,    differs: KeyValueDiffers,    elementRef: ElementRef,    platformId: Object,    defaults: PerfectScrollbarConfigInterface);property config
config?: PerfectScrollbarConfigInterface;property disabled
disabled: boolean;property elementRef
elementRef: ElementRef;property psScrollDown
psScrollDown: EventEmitter<any>;property psScrollLeft
psScrollLeft: EventEmitter<any>;property psScrollRight
psScrollRight: EventEmitter<any>;property psScrollUp
psScrollUp: EventEmitter<any>;property psScrollX
psScrollX: EventEmitter<any>;property psScrollY
psScrollY: EventEmitter<any>;property psXReachEnd
psXReachEnd: EventEmitter<any>;property psXReachStart
psXReachStart: EventEmitter<any>;property psYReachEnd
psYReachEnd: EventEmitter<any>;property psYReachStart
psYReachStart: EventEmitter<any>;method geometry
geometry: (prefix?: string) => Geometry;method ngDoCheck
ngDoCheck: () => void;method ngOnChanges
ngOnChanges: (changes: SimpleChanges) => void;method ngOnDestroy
ngOnDestroy: () => void;method ngOnInit
ngOnInit: () => void;method position
position: (absolute?: boolean) => Position;method ps
ps: () => PerfectScrollbar | null;method scrollable
scrollable: (direction?: string) => boolean;method scrollTo
scrollTo: (x: number, y?: number, speed?: number) => void;method scrollToBottom
scrollToBottom: (offset?: number, speed?: number) => void;method scrollToElement
scrollToElement: (    element: HTMLElement | string,    offset?: number,    speed?: number) => void;method scrollToLeft
scrollToLeft: (offset?: number, speed?: number) => void;method scrollToRight
scrollToRight: (offset?: number, speed?: number) => void;method scrollToTop
scrollToTop: (offset?: number, speed?: number) => void;method scrollToX
scrollToX: (x: number, speed?: number) => void;method scrollToY
scrollToY: (y: number, speed?: number) => void;method update
update: () => void;class PerfectScrollbarModule
class PerfectScrollbarModule {}class Position
class Position {}constructor
constructor(x: number | 'start' | 'end', y: number | 'start' | 'end');property x
x: number | 'start' | 'end';property y
y: number | 'start' | 'end';Interfaces
interface PerfectScrollbarConfigInterface
interface PerfectScrollbarConfigInterface {}property handlers
handlers?: string[];property maxScrollbarLength
maxScrollbarLength?: number;property minScrollbarLength
minScrollbarLength?: number;property scrollingThreshold
scrollingThreshold?: number;property scrollXMarginOffset
scrollXMarginOffset?: number;property scrollYMarginOffset
scrollYMarginOffset?: number;property suppressScrollX
suppressScrollX?: boolean;property suppressScrollY
suppressScrollY?: boolean;property swipeEasing
swipeEasing?: boolean;property useBothWheelAxes
useBothWheelAxes?: boolean;property wheelPropagation
wheelPropagation?: boolean;property wheelSpeed
wheelSpeed?: number;Package Files (6)
Dependencies (3)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ngx-perfect-scrollbar.
- Markdown[](https://www.jsdocs.io/package/ngx-perfect-scrollbar)
- HTML<a href="https://www.jsdocs.io/package/ngx-perfect-scrollbar"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
 Package analyzed in 4119 ms.
- Missing or incorrect documentation? Open an issue for this package.
