1.1.1 • Published 2 years ago

react-nivo-slider v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-nivo-slider

version typescript esm npm bundle size (version) GitHub Repo stars

Getting Started

Install dependencies,

$ npm i react-nivo-slider

Docs & Demo

Github Pages

Usage

import React from 'react';
import { Image, Link, Swiper } from 'react-nivo-slider';
import 'react-nivo-slider/es/style';
import 'react-nivo-slider/es/style/default';
import { NemoJpg, ToyStoryJpg, UpJpg, WalleJpg } from './img';

const logger = (msg: string) => () => console.log(msg);

export default function DefaultDemo() {
  return (
    <Swiper>
      <Link href="https://www.surpath.net.cn">
        <Image src={NemoJpg} alt="image1" onClick={logger('bad event handler')} />
      </Link>
      <Image
        src={ToyStoryJpg}
        alt="image2"
        title="image2"
        onClick={logger('image2 Clicked')}
      />
      <Image src={WalleJpg} alt="image3" onClick={logger('image3 Clicked')} />
      <Image src={UpJpg} alt="image4" onClick={logger('image4 Clicked')} />
    </Swiper>
  );
}

API

Swiper props

propsdescriptiontypedefault
className-string-
style-CSSProperties-
themethemedefault | light | dark | bardefault
effecttransition effectEffectTyperandom
slicesswiper slicenumber15
boxColsbox col numnumber8
boxRows-number4
animSpeedanimation duration(ms)number500
pauseTime-number3000
startSlide-number0
directionNavshow directionNavbooleantrue
controlNavshow controlNavbooleantrue
controlNavThumbsshow controlNavThumbsbooleanfalse
pauseOnHover-booleantrue
manualAdvance-booleanfalse
prevTextprev button textstringPrev
nextTextnext button textstringnextText
randomStart-booleanfalse
beforeChangebefore slide changefunction-
afterChangeafter slide changefunction-
afterLoadafter swiper initfunction-
lastSlidebefore last slide start animationfunction-
slideshowEndon last slide showfunction-

useSwiper

propsdescriptiontypedefault
widthswiper widthnumber-
activeIndex-number-
slidesswiper slidesReact.ReactElement<any, string | React.JSXElementConstructor>[][]
slideToslide to target slide(index: number) => void-
slideNextslide to next slide() => void-
slidePrevslide to prev slide() => void-

Image

propsdescriptiontypedefault
className-string-
style-CSSProperties-
alt-string-
titlecaption inner text or nodestring | node-
transition-EffectType-
thumbthumb image src when controlNavThumbs it's truestring-
onClick-() => void-

Link

same as a tag

EffectType

type EffectType =
  | `random`
  | `fade`
  | `fold`
  | `sliceDown`
  | `sliceDownRight`
  | `sliceDownLeft`
  | `sliceUp`
  | `sliceUpRight`
  | `sliceUpLeft`
  | `sliceUpDown`
  | `sliceUpDownLeft`
  | `sliceUpDownRight`
  | `slideInRight`
  | `slideInLeft`
  | `boxRandom`
  | `boxRain`
  | `boxRainReverse`
  | `boxRainGrow`
  | `boxRainGrowReverse`;

Support By

Nivo-Slider-jQuery