0.0.5 • Published 6 years ago

xerxes-react-carousel v0.0.5

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

xerxes-react-carousel

NPM version Build Status npm

基本介绍

这是一个基于 reactjs 的轮播图组件,包含基本的轮播和3d的轮播效果。

安装说明

使用 npm 或者 yarn 进行安装

npm i xerxes-react-carousel or yarn add xerxes-react-carousel

如何使用

import React from 'react'
import ReactDOM from 'react-dom'
import Carousel from 'xerxes-react-carousel'
import 'xerxes-react-carousel/lib/index.css'

const list = [
  {
    img: require('./assets/images/pexels-photo-210019.jpeg')
  },
  {
    img: require('./assets/images/pexels-photo-593172.jpeg')
  },
  {
    img: require('./assets/images/pexels-photo-210019.jpeg')
  },
  {
    img: require('./assets/images/pexels-photo-593172.jpeg')
  },
  {
    img: require('./assets/images/pexels-photo-210019.jpeg')
  },
]

const App = () => (
  <Carousel type="card">
    {list.map((item, index) => (
      <Carousel.Item key={index}>
        <div style={{ height: '100%' }}>
          <img style={{ width: '100%', height: '100%' }} src={item.img} alt={index} />
          <h4>{index + 1}</h4>
        </div>
      </Carousel.Item>
    ))}
  </Carousel>
)

ReactDOM.render(<App />, document.getElementById('root'))

props说明

属性类型默认值可选值描述
initIndexNumber--初始化时指向的carouselItem 的下标,默认从0开始
heightNumber300> 0设置组件的高度
autoplayBooleanfalsetrue or false是否自动播放
typeStringcard轮播图的类型
intervalNumber3000> 0轮播切换的间隔时间,单位ms
arrowBooleantruefalse or true是否显示切换按钮
indicatorBooleantruefalse or true是否显示指示器
indicatorPositionStringoutside or none指示器的位置
indicatorClassNameString---指示器的类名

events说明

事件名称回调参数事件说明
onChange当前激活的索引, 上一个的索引

methods说明

方法名称方法说明
prev切换到上一个索引
next切换到下一个索引