Function Swiper

  • Swiper(props): ReactNode

  • Parameters

    • props: {
          allowTouchMove?: boolean;
          autoplay?: boolean;
          autoplayInterval?: number;
          children?: ReactElement<any, string | JSXElementConstructor<any>> | ReactElement<any, string | JSXElementConstructor<any>>[] | ((index) => ReactElement<any, string | JSXElementConstructor<any>>);
          defaultIndex?: number;
          direction?: "horizontal" | "vertical";
          indicator?: false | ((total, current) => ReactNode);
          indicatorProps?: Pick<PageIndicatorProps, "style" | "className" | "color">;
          loop?: boolean;
          onIndexChange?: ((index) => void);
          rubberband?: boolean;
          slideSize?: number;
          stopPropagation?: ("mousedown" | "mousemove" | "mouseup")[];
          stuckAtBoundary?: boolean;
          total?: number;
          trackOffset?: number;
      } & {
          className?: string;
          style?: CSSProperties & Partial<Record<"--border-radius" | "--height" | "--width" | "--track-padding", string>>;
          tabIndex?: number;
      } & AriaAttributes & RefAttributes<SwiperRef>

    Returns ReactNode

Properties

$$typeof Item defaultProps? displayName? propTypes?

Properties

Readonly $$typeof

$$typeof: symbol

Item

Item: FC<{
    children?: ReactNode;
    onClick?: ((e) => void);
} & {
    className?: string;
    style?: CSSProperties & Partial<Record<never, string>>;
    tabIndex?: number;
} & AriaAttributes>

Optional defaultProps

defaultProps?: Partial<{
    allowTouchMove?: boolean;
    autoplay?: boolean;
    autoplayInterval?: number;
    children?: ReactElement<any, string | JSXElementConstructor<any>> | ReactElement<any, string | JSXElementConstructor<any>>[] | ((index) => ReactElement<any, string | JSXElementConstructor<any>>);
    defaultIndex?: number;
    direction?: "horizontal" | "vertical";
    indicator?: false | ((total, current) => ReactNode);
    indicatorProps?: Pick<PageIndicatorProps, "style" | "className" | "color">;
    loop?: boolean;
    onIndexChange?: ((index) => void);
    rubberband?: boolean;
    slideSize?: number;
    stopPropagation?: ("mousedown" | "mousemove" | "mouseup")[];
    stuckAtBoundary?: boolean;
    total?: number;
    trackOffset?: number;
} & {
    className?: string;
    style?: CSSProperties & Partial<Record<"--border-radius" | "--height" | "--width" | "--track-padding", string>>;
    tabIndex?: number;
} & AriaAttributes & RefAttributes<SwiperRef>>

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Optional propTypes

propTypes?: WeakValidationMap<{
    allowTouchMove?: boolean;
    autoplay?: boolean;
    autoplayInterval?: number;
    children?: ReactElement<any, string | JSXElementConstructor<any>> | ReactElement<any, string | JSXElementConstructor<any>>[] | ((index) => ReactElement<any, string | JSXElementConstructor<any>>);
    defaultIndex?: number;
    direction?: "horizontal" | "vertical";
    indicator?: false | ((total, current) => ReactNode);
    indicatorProps?: Pick<PageIndicatorProps, "style" | "className" | "color">;
    loop?: boolean;
    onIndexChange?: ((index) => void);
    rubberband?: boolean;
    slideSize?: number;
    stopPropagation?: ("mousedown" | "mousemove" | "mouseup")[];
    stuckAtBoundary?: boolean;
    total?: number;
    trackOffset?: number;
} & {
    className?: string;
    style?: CSSProperties & Partial<Record<"--border-radius" | "--height" | "--width" | "--track-padding", string>>;
    tabIndex?: number;
} & AriaAttributes & RefAttributes<SwiperRef>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc