import { KbqScrollbarModule } from '@koobiq/components/scrollbar';

The component-wrapper for `overlayscrollbars` library.

Selector: kbq-scrollbar, [kbq-scrollbar]

Exported as: kbqScrollbar
Properties
Name Description
@Input()
defer: boolean | IdleRequestOptions
Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported)
@Input()
events: EventListeners$1
@Input()
initializationTarget: InitializationTarget
Elements scrollbar applied on
@Input()
options: DeepPartial
Scrollbar behavior customization object
@Output('onDestroy')
onDestroy: EventEmitter<[instance: OverlayScrollbars, canceled: boolean]>
Event triggered when scrollbar instance destroyed
@Output('onInitialize')
onInitialize: EventEmitter<[instance: OverlayScrollbars]>
@Output('onScroll')
onScroll: EventEmitter<[instance: OverlayScrollbars, event: Event]>
@Output('onUpdate')
onUpdate: EventEmitter<[instance: OverlayScrollbars, onUpdatedArgs: OnUpdatedEventListenerArgs]>
Event triggered when options or event listeners updated
contentElement: ElementRef Element that is being overflowed
element: HTMLElement
Methods
mergeEvents
scrollTo
Wrapper function for native scroll

A directive for adding `overlayscrollbars` to an element.

Selector: [kbqScrollbar]

Properties
Name Description
@Input()
defer: boolean | IdleRequestOptions
Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported)
@Input()
events: EventListeners$1
@Input()
options: DeepPartial
scrollbarInstance: OverlayScrollbars
Methods
initialize
type KbqScrollbarEvents = EventListeners;
type KbqScrollbarEventListenerArgs = EventListenerArgs;
type KbqScrollbarOptions = PartialOptions;
type KbqScrollbarTarget = InitializationTarget;
const KBQ_SCROLLBAR_OPTIONS_DEFAULT_CONFIG: DeepPartial<Options>;
const KBQ_SCROLLBAR_CONFIG: InjectionToken<DeepPartial<Options>>;

Default scroll behavior

const KBQ_SCROLLBAR_OPTIONS_DEFAULT_CONFIG_PROVIDER: Provider;
Docs Feedback
If you have any questions or would like to contribute to writing the documentation, please create an issue in our GitHub repository.