wix-style-react/dist/src/Carousel/index.d.ts

wix-style-react

import * as React from 'react';
import { IconButtonSkin } from '../IconButton';

export type CarouselControlsPosition = 'sides' | 'overlay' | 'bottom' | 'none';

export default class Carousel extends React.Component<CarouselProps> {
  leftIconByControlSize(
    controlSize: 'tiny' | 'small' | 'medium',
  ): React.FC<React.SVGAttributes<SVGElement> & { size?: string | number }>;
  rightIconByControlSize(
    controlSize: 'tiny' | 'small' | 'medium',
  ): React.FC<React.SVGAttributes<SVGElement> & { size?: string | number }>;
  slideTo(index: number): void;
}

export type CarouselImage = Partial<HTMLImageElement> & { src: string };

export interface CarouselProps {
  dataHook?: string;
  className?: string;
  images?: CarouselImage[];
  imagesPosition?: React.CSSProperties['objectPosition'];
  imagesFit?: React.CSSProperties['objectFit'];
  buttonSkin?: IconButtonSkin;
  infinite?: boolean;
  autoplay?: boolean;
  dots?: boolean;
  variableWidth?: boolean;
  initialSlideIndex?: number;
  afterChange?: (currentSlide: number) => void;
  beforeChange?: (currentSlide: number, nextSlide: number) => void;
  controlsPosition?: CarouselControlsPosition;
  controlsSize?: 'tiny' | 'small' | 'medium';
  controlsStartEnd?: 'disabled' | 'hidden';
  showControlsShadow?: boolean;
  children?: React.ReactNode;
}