Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Swiper

Hierarchy

Index

Constructors

constructor

Properties

Optional autoplayTimer

autoplayTimer: number

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

isMouseEnter

isMouseEnter: boolean

isSwiping

isSwiping: boolean

Readonly props

props: Readonly<ISwiperProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: { currentIndex: number } = ...

Type declaration

  • currentIndex: number

swiper

swiper: HTMLDivElement

swiperContainer

swiperContainer: HTMLDivElement

swiperWidth

swiperWidth: number

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Static defaultProps

defaultProps: { arrows: boolean; arrowsDisabled: { left: boolean; right: boolean }; arrowsSize: string; arrowsType: string; autoplay: boolean; autoplayInterval: number; className: string; dots: boolean; dotsSize: string; dotsTheme: string; renderNextArrow: (onNext: () => void, disabled: boolean) => ReactNode; renderPrevArrow: (onPrev: () => void, disabled: boolean) => ReactNode; transitionDuration: number } = ...

Type declaration

  • arrows: boolean
  • arrowsDisabled: { left: boolean; right: boolean }
    • left: boolean
    • right: boolean
  • arrowsSize: string
  • arrowsType: string
  • autoplay: boolean
  • autoplayInterval: number
  • className: string
  • dots: boolean
  • dotsSize: string
  • dotsTheme: string
  • renderNextArrow: (onNext: () => void, disabled: boolean) => ReactNode
      • (onNext: () => void, disabled: boolean): ReactNode
      • Parameters

        • onNext: () => void
            • (): void
            • Returns void

        • disabled: boolean

        Returns ReactNode

  • renderPrevArrow: (onPrev: () => void, disabled: boolean) => ReactNode
      • (onPrev: () => void, disabled: boolean): ReactNode
      • Parameters

        • onPrev: () => void
            • (): void
            • Returns void

        • disabled: boolean

        Returns ReactNode

  • transitionDuration: number

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<ISwiperProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<ISwiperProps>, nextState: Readonly<ISwiperState>, nextContext: any): void

clearAutoplay

  • clearAutoplay(): void

cloneChildren

  • cloneChildren(children?: ReactNode): ReactNode

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<ISwiperProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

getRealPrevIndex

  • getRealPrevIndex(index: number): number

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

getSwiper

  • getSwiper(swiper: HTMLDivElement): void

getSwiperContainer

  • getSwiperContainer(swiperContainer: HTMLDivElement): void

handleDotsClick

  • handleDotsClick(index: number): void

handleMouseEnter

  • handleMouseEnter(): void

handleMouseLeave

  • handleMouseLeave(): void

handleResize

  • handleResize(): void

init

  • init(isResetToOrigin?: boolean): void

next

  • next(): void

prev

  • prev(): void

render

  • render(): Element

resetPosition

  • resetPosition(currentIndex: number): void

setState

setSwiperWidth

  • setSwiperWidth(): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ISwiperProps>, nextState: Readonly<ISwiperState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

startAutoplay

  • startAutoplay(): void

swipeTo

  • swipeTo(index: number): void

translate

  • translate(currentIndex: number, prevIndex: number, isSilent?: boolean): void

Static getDerivedStateFromProps

Generated using TypeDoc