react-owl-carousel
Version:
React.js + Owl Carousel
88 lines (87 loc) • 3.25 kB
TypeScript
export interface Options {
items?: number;
margin?: number;
loop?: boolean;
center?: boolean;
mouseDrag?: boolean;
touchDrag?: boolean;
pullDrag?: boolean;
freeDrag?: boolean;
stagePadding?: number;
merge?: boolean;
mergeFit?: boolean;
autoWidth?: boolean;
startPosition?: number | string;
URLhashListener?: boolean;
nav?: boolean;
rewind?: boolean;
navText?: string[];
navElement?: string;
slideBy?: number | string;
dots?: boolean;
dotsEach?: number | boolean;
dotData?: boolean;
lazyLoad?: boolean;
lazyContent?: boolean;
autoplay?: boolean;
autoplayTimeout?: number;
autoplayHoverPause?: boolean;
smartSpeed?: number | boolean;
fluidSpeed?: number | boolean;
autoplaySpeed?: number | boolean;
navSpeed?: number | boolean;
dotsSpeed?: number | boolean;
dragEndSpeed?: number | boolean;
callbacks?: boolean;
responsive?: {
[breakpoint: string]: Options;
};
responsiveRefreshRate?: number;
responsiveBaseElement?: Element;
video?: boolean;
videoHeight?: number | boolean;
videoWidth?: number | boolean;
animateOut?: string | boolean;
animateIn?: string | boolean;
fallbackEasing?: string;
info?: HandlerCallback;
nestedItemSelector?: string;
itemElement?: string;
stageElement?: string;
navContainer?: string | boolean;
dotsContainer?: string | boolean;
refreshClass?: string;
loadingClass?: string;
loadedClass?: string;
rtlClass?: string;
dragClass?: string;
grabClass?: string;
stageClass?: string;
stageOuterClass?: string;
navContainerClass?: string;
navClass?: string[];
controlsClass?: string;
dotClass?: string;
dotsClass?: string;
autoHeightClass?: string;
responsiveClass?: string | boolean;
onInitialize?: HandlerCallback;
onInitialized?: HandlerCallback;
onResize?: HandlerCallback;
onResized?: HandlerCallback;
onRefresh?: HandlerCallback;
onRefreshed?: HandlerCallback;
onDrag?: HandlerCallback;
onDragged?: HandlerCallback;
onTranslate?: HandlerCallback;
onTranslated?: HandlerCallback;
onChange?: HandlerCallback;
onChanged?: HandlerCallback;
onLoadLazy?: HandlerCallback;
onLoadedLazy?: HandlerCallback;
onStopVideo?: HandlerCallback;
onPlayVideo?: HandlerCallback;
}
export declare type HandlerCallback = (...args: any[]) => void;
export declare type OnEvent = 'initialize.owl.carousel' | 'initialized.owl.carousel' | 'resize.owl.carousel' | 'resized.owl.carousel' | 'refresh.owl.carousel' | 'refreshed.owl.carousel' | 'drag.owl.carousel' | 'dragged.owl.carousel' | 'translate.owl.carousel' | 'translated.owl.carousel' | 'change.owl.carousel' | 'changed.owl.carousel' | 'load.owl.lazy' | 'loaded.owl.lazy' | 'stop.owl.video' | 'play.owl.video';
export declare type TriggerEvent = 'refresh.owl.carousel' | 'next.owl.carousel' | 'prev.owl.carousel' | 'to.owl.carousel' | 'destroy.owl.carousel' | 'replace.owl.carousel' | 'add.owl.carousel' | 'remove.owl.carousel' | 'play.owl.autoplay' | 'stop.owl.autoplay';