Skip to content

ArSrNa/react-fade-slider

Repository files navigation

React Slider 轮播图

复现Apple官网轮播介绍效果。

CNB不支持视频直接预览,点此查看效果

查看Demo

使用

安装

npm i react-fade-slider

基本用法

import SliderComp, { itemProps } from 'react-fade-slider';
// 没有注入js,只能手动引入css
import 'react-fade-slider/dist/index.css';

function App() {
  const item: itemProps[] = [{
    title: '这是标题',
    content: <>内容123456789<button>按钮</button></>,
    src: "/5b60764dabc3bf50c2ad7b5ff8eae80b_2607687582866761407.png"
  }, {
    title: '<>这是标题2</>',
    content: <>我永远喜欢薇塔</>,
    src: "/16de7766a642388d21e4c76cacfde801_5165224128247218265.png"
  }, {
    title: '这是标题3',
    content: <>内容123456789<button>按钮</button></>,
    src: "/fa9fc6e9532e4c56c9ad0e5e9548a06a_2258061419554533859.png"
  }];

  return (
    <>
      <Slider item={item} />
    </>
  );
}

轮播

启用轮播,设置autoplaytrueinterval为轮播间隔(毫秒),建议不小于3秒,使动画能够完整播放。

<Slider item={item} autoplay interval={3000}/>

禁用背景图片

默认开启了背景图片填充,在translate动画的情况下防止背景一片空白,如果需要禁用,设置backgroundImagefalse

<Slider item={item} backgroundImage={false}/>

缩放比例

图片自带缩放动画,可以设置缩放比例,默认1.15,如果图片太大,可以设置为1.2

<Slider item={item} scaleRatio={1.15}/>

自动暂停

鼠标悬停时自动暂停轮播,默认开启,设置pauseOnHoverfalse禁用。

<Slider item={item} pauseOnHover={false}/>

demo测试

克隆本仓库

git clone https://cnb.cool/arsrna/os/react-fade-slider.git
cd react-fade-slider

安装依赖并启动

pnpm i
pnpm start

访问http://localhost:5173查看效果

开发

包目录在packages/Slider.tsxpackages/index.tsx是入口文件

packages/index.module.scss是样式文件。为防止css选择器冲突,这里使用模块化css,在使用tsx组件的时候,要设置className={styles.xxx(xxx为class名)}

API

字段 类型 是否必填 释义 默认值
item itemProps[] 轮播项数据,包含标题、内容、图片等 void '我永远喜欢爱莉希雅'
style CSSProperties 轮播容器的样式 void '我永远喜欢爱莉希雅'
itemStyle CSSProperties 每个轮播项容器的样式 { height: '60vh' }
imgStyle CSSProperties 每个轮播项图片的样式 { "--scale-ratio": scaleRatio }
backgroundImage boolean 是否启用背景图片 true
autoplay boolean 是否自动播放 true
interval number 自动播放间隔(毫秒),建议不小于 3 秒 5000
pauseOnHover boolean 鼠标悬停时是否暂停轮播, true
scaleRatio number 缩放比例 1.15
onChange (index: number) => any 切换回调 void '我永远喜欢爱莉希雅'

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published