overlayscrollbars-svelte/useOverlayScrollbars.svelte.d.ts

OverlayScrollbars for Svelte.

import { type InitializationTarget } from 'overlayscrollbars';
import type { OverlayScrollbarsComponentProps, OverlayScrollbarsComponentRef } from './OverlayScrollbarsComponent.types';
export interface UseOverlayScrollbarsParams {
    /** OverlayScrollbars options. */
    options?: OverlayScrollbarsComponentProps['options'] | Accessor<OverlayScrollbarsComponentProps['options']>;
    /** OverlayScrollbars events. */
    events?: OverlayScrollbarsComponentProps['events'] | Accessor<OverlayScrollbarsComponentProps['events']>;
    /** 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) */
    defer?: OverlayScrollbarsComponentProps['defer'] | Accessor<OverlayScrollbarsComponentProps['defer']>;
}
export type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;
export type UseOverlayScrollbarsInstance = () => ReturnType<OverlayScrollbarsComponentRef['osInstance']>;
type Accessor<T> = () => T;
export declare const useOverlayScrollbars: (params?: UseOverlayScrollbarsParams | Accessor<UseOverlayScrollbarsParams>) => [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance];
export {};