@wix/design-system
Version:
@wix/design-system
19 lines • 948 B
TypeScript
import React from 'react';
import type { PartialOptions } from 'overlayscrollbars';
export type UseOverlayScrollbarsParams = {
/** OverlayScrollbars options. */
options?: PartialOptions | false | null;
};
export type OverlayScrollbarHost = React.FunctionComponent<{
className?: string;
children: React.ReactNode;
} & React.HTMLAttributes<HTMLDivElement>>;
export type OverlayScrollbarContent = React.ForwardRefExoticComponent<React.PropsWithoutRef<React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>>;
/**
* @param params Parameters for customization.
* @returns A tuple with two values:
* The first value is the overlay scrollbar host component.
* The second value is the overlay scrollbar content component.
*/
export declare const useOverlayScrollbar: (params?: UseOverlayScrollbarsParams) => readonly [OverlayScrollbarHost, OverlayScrollbarContent];
//# sourceMappingURL=useOverlayScrollbar.d.ts.map