@faceless-ui/slider
Version:
A React library for building every kind of slider
30 lines (29 loc) • 959 B
TypeScript
import React from 'react';
import { type ISliderContext } from './context.js';
export type ChildFunction = (context: ISliderContext) => React.ReactNode;
export type SliderSettings = {
slidesToShow?: number;
slideOnSelect?: boolean;
scrollable?: boolean;
useFreeScroll?: boolean;
dragScroll?: boolean;
scrollSnap?: boolean;
scrollOffset?: number;
autoPlay?: boolean;
autoplaySpeed?: number;
marquee?: boolean;
marqueeSpeed?: number;
pauseOnHover?: boolean;
alignLastSlide?: 'trackLeft' | 'offsetLeft' | string | number;
};
export type SliderProviderProps = SliderSettings & {
children: React.ReactNode | ChildFunction;
currentSlideIndex?: number;
onSlide?: (index: number) => void;
pause?: boolean;
id?: string;
breakpoints?: {
[key: string]: Omit<SliderProviderProps, "children" | "breakpoints">;
};
};
export declare const SliderProvider: React.FC<SliderProviderProps>;