react-awesome-slider/index.d.ts

React Awesome Slider is a 60fps performant, extendable, highly customisable, production ready React Component that renders a media (image/video) gallery slider carousel.

// Type definitions for react-awesome-slider
// Project: https://github.com/rcaferati/react-awesome-slider
// Definitions by: Rafael Caferati <https://github.com/rcaferati>
// TypeScript Version: 3.0.0

declare module 'react-awesome-slider' {
  import React, { Component } from 'react';

  export interface AwesomeSliderInfo {
    slides: number;
    currentIndex: number;
    currentSlide: HTMLElement;
    currentMedia: React.ReactNode;
    element: HTMLElement;
  }

  export interface AwesomeSliderRequestEventArgs extends AwesomeSliderInfo {
    nextIndex: number;
  }

  export interface AwesomeSliderStartEventArgs extends AwesomeSliderRequestEventArgs {
    nextSlide: HTMLElement;
    nextMedia: React.ReactNode;
  }
  
  export interface AwesomeSliderProps {
    activityColor?: string;
    animation?: string;
    bullets?: boolean;
    buttonContentLeft?: React.ReactNode;
    buttonContentRight?: React.ReactNode;
    buttons?: boolean;
    children?: React.ReactNode;
    className?: string;
    controlsReturnDelay?: number;
    cssModule?: object;
    customContent?: React.ReactNode;
    disabled?: boolean;
    fillParent?: boolean;
    infinite?: boolean;
    media?: any;
    name?: string;
    onFirstMount?(e: AwesomeSliderInfo): void;
    onLoadStart?(): void;
    onResetSlider?(): void;
    onStartupRelease?(): void;
    onTransitionEnd?(e: AwesomeSliderInfo): void;
    onTransitionRequest?(e: AwesomeSliderRequestEventArgs): void;
    onTransitionStart?(e: AwesomeSliderStartEventArgs): void;
    organicArrows?: boolean;
    rootElement?: string;
    selected?: string | number;
    startup?: boolean;
    startupDelay?: number;
    startupScreen?: object;
    style?: object;
    transitionDelay?: number;
    mobileTouch?: boolean;
  }

  export default class AwesomeSlider extends Component<
    AwesomeSliderProps,
    {}
  > {}
}