DefinitelyTyped/types/react-native-swiper/index.d.ts

// Type definitions for react-native-swiper 1.5
// Project: https://github.com/leecade/react-native-swiper#readme
// Definitions by: CaiHuan <https://github.com/CaiHuan>
//                 HuHuanming <https://github.com/huhuanming>
//                 mhcgrq <https://github.com/mhcgrq>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

import * as React from 'react';
import {
  ViewStyle,
  StyleProp,
  NativeSyntheticEvent,
  NativeScrollEvent,
} from 'react-native';

export interface SwiperState {
  autoplayEnd: boolean;
  dir: 'x' | 'y';
  height: number;
  width: number;
  index: number;
  isScrolling: boolean;
  loopJump: boolean;
  offset: {
    x: number;
    y: number;
  };
  total: number;
}

export interface SwiperProperties extends React.Props<Swiper> {
  horizontal?: boolean;

  style?: StyleProp<ViewStyle>;

  pagingEnabled?: boolean;

  showsHorizontalScrollIndicator?: boolean;

  showsVerticalScrollIndicator?: boolean;

  bounces?: boolean;

  scrollsToTop?: boolean;

  scrollEnabled?: boolean;

  removeClippedSubviews?: boolean;

  automaticallyAdjustContentInsets?: boolean;

  showsPagination?: boolean;

  showsButtons?: boolean;

  loadMinimal?: boolean;

  loadMinimalSize?: number;

  loadMinimalLoader?: JSX.Element;

  loop?: boolean;

  autoplay?: boolean;

  autoplayTimeout?: number;

  autoplayDirection?: boolean;

  index?: number;

  renderPagination?(index: number, total: number, thisObject: Swiper): JSX.Element;

  dotStyle?: StyleProp<ViewStyle>;

  activeDotStyle?: StyleProp<ViewStyle>;

  activeDot?: JSX.Element;

  dot?: JSX.Element;

  dotColor?: string;

  activeDotColor?: string;

  height?: number;

  width?: number;

  paginationStyle?: StyleProp<ViewStyle>;

  buttonWrapperStyle?: StyleProp<ViewStyle>;

  nextButton?: JSX.Element;

  prevButton?: JSX.Element;

  onScrollBeginDrag?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;

  onMomentumScrollEnd?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;

  onTouchStartCapture?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;

  onTouchStart?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;

  onTouchEnd?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;

  onResponderRelease?(
    event: NativeSyntheticEvent<NativeScrollEvent>,
    state: SwiperState,
    context: Swiper
  ): void;
}

export default class Swiper extends React.Component<SwiperProperties, SwiperState> {
  scrollBy(index: number, animated: boolean): void;
}