welcome-ui
Version:
Customizable design system with react, typescript, tailwindcss and ariakit.
61 lines (60 loc) • 1.71 kB
TypeScript
import { default as swiperStyles } from './swiper.module.scss';
import { SwiperComponent, UseSwiperOptions } from './types';
export { swiperStyles as swiperClasses };
type SwiperContextValue = {
navigation: {
desktop: boolean;
goNext: () => void;
goPrev: () => void;
isNextDisabled: boolean;
isPrevDisabled: boolean;
mobile: boolean;
};
slides: {
alignment: 'center' | 'default';
currentPage: number;
currentSlidesPerView: number;
expandOnLargeScreens: boolean;
gap: number;
handleScroll: () => void;
id: string;
initialIndex: number;
isLastPage: boolean;
length: number;
perView: {
desktop: number;
mobile: number;
tablet: number;
};
ref: React.RefObject<HTMLUListElement>;
setLength: (length: number) => void;
};
};
export declare const useSwiperContext: () => SwiperContextValue;
export declare const useSwiper: (options?: UseSwiperOptions) => {
autoplay: {
duration: number;
enabled: boolean;
loop: boolean;
};
navigation: {
desktop: boolean;
mobile: boolean;
};
slides: {
alignment: "center" | "default";
currentPage: number;
currentSlidesPerView: number;
expandOnLargeScreens: boolean;
gap: number;
id: string;
initialIndex: number;
perView: {
desktop: number;
mobile: number;
tablet: number;
};
setCurrentPage: React.Dispatch<React.SetStateAction<number>>;
};
};
export declare const Swiper: SwiperComponent;