smooth-scrollbar/options.d.ts

Customize scrollbar in modern browsers with smooth scrolling experience.

import { ScrollbarOptions } from './interfaces/';
export declare class Options {
    /**
     * Momentum reduction damping factor, a float value between `(0, 1)`.
     * The lower the value is, the more smooth the scrolling will be
     * (also the more paint frames).
     */
    damping: number;
    /**
     * Minimal size for scrollbar thumbs.
     */
    thumbMinSize: number;
    /**
     * Render every frame in integer pixel values
     * set to `true` to improve scrolling performance.
     */
    renderByPixels: boolean;
    /**
     * Keep scrollbar tracks visible
     */
    alwaysShowTracks: boolean;
    /**
     * Set to `true` to allow outer scrollbars continue scrolling
     * when current scrollbar reaches edge.
     */
    continuousScrolling: boolean;
    /**
     * Delegate wheel events and touch events to the given element.
     * By default, the container element is used.
     * This option will be useful for dealing with fixed elements.
     */
    delegateTo: EventTarget | null;
    wheelEventTarget: EventTarget | null;
    /**
     * Options for plugins. Syntax:
     *   plugins[pluginName] = pluginOptions: any
     */
    readonly plugins: any;
    constructor(config?: Partial<ScrollbarOptions>);
}