faeat(Carousel): 增加走马灯组件Carousel #691
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| Carousel 走马灯 | ||
| === | ||
|
|
||
| [](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-carousel/file/README.md) | ||
| [](https://www.npmjs.com/package/@uiw/react-carousel) | ||
| [](https://npmjs.com/@uiw/react-carousel) | ||
|
|
||
| 滚动播放。在 v4.15.0+ 添加。 | ||
|
|
||
| ## 基础用法 | ||
|
|
||
| 最简单的用法。 | ||
|
|
||
| <!--rehype:bgWhite=true&codeSandbox=true&codePen=true--> | ||
| ```jsx | ||
| import React from 'react'; | ||
| import { Carousel } from 'uiw'; | ||
|
|
||
| function Demo() { | ||
| return ( | ||
| <Carousel> | ||
| <div style={{ height: '100%', background: '#1EABCD' }}> | ||
| <span>1</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393b46' }}> | ||
| <span>2</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#008EF0' }}> | ||
| <span>3</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393E48' }}> | ||
| <span>4</span> | ||
| </div> | ||
| </Carousel> | ||
| ); | ||
| } | ||
|
|
||
| ReactDOM.render(<Demo />, _mount_); | ||
| ``` | ||
|
|
||
| ## 控制播放频率 | ||
|
|
||
| palyTime设置每帧停留时间，scrollTime设置切换帧的速度 | ||
|
|
||
| <!--rehype:bgWhite=true&codeSandbox=true&codePen=true--> | ||
| ```jsx | ||
| import React from 'react'; | ||
| import { Carousel } from 'uiw'; | ||
|
|
||
| function Demo() { | ||
| return ( | ||
| <Carousel palyTime={1000} scrollTime={500}> | ||
| <div style={{ height: '100%', background: '#1EABCD' }}> | ||
| <span>1</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393b46' }}> | ||
| <span>2</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#008EF0' }}> | ||
| <span>3</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393E48' }}> | ||
| <span>4</span> | ||
| </div> | ||
| </Carousel> | ||
| ); | ||
| } | ||
|
|
||
| ReactDOM.render(<Demo />, _mount_); | ||
| ``` | ||
|
|
||
| ## 切换到指定帧 | ||
|
|
||
| 手动切换到指定帧的位置 | ||
|
|
||
| <!--rehype:bgWhite=true&codeSandbox=true&codePen=true--> | ||
| ```jsx | ||
| import React from 'react'; | ||
| import { Carousel } from 'uiw'; | ||
|
|
||
| function Demo() { | ||
|
|
||
| const ref=React.useRef() | ||
| const [autoPlay,autoPlaySet]=React.useState(true) | ||
|
|
||
| return ( | ||
| <React.Fragment> | ||
| <Carousel ref={ref} position={2} autoPlay={autoPlay}> | ||
| <div style={{ height: '100%', background: '#1EABCD' }}> | ||
| <span>1</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393b46' }}> | ||
| <span>2</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#008EF0' }}> | ||
| <span>3</span> | ||
| </div> | ||
| <div style={{ height: '100%', background: '#393E48' }}> | ||
| <span>4</span> | ||
| </div> | ||
| </Carousel> | ||
| <button onClick={() => ref.current.gotoSlide(1)}>跳转</button> | ||
| <button onClick={() => ref.current.prevSlide()}>上一张</button> | ||
| <button onClick={() => ref.current.nextSlide()}>下一张</button> | ||
| <button onClick={() =>autoPlaySet(autoPlay?false:true)}>{autoPlay?'暂停':'开始'}</button> | ||
| </React.Fragment> | ||
| ); | ||
| } | ||
|
|
||
| ReactDOM.render(<Demo />, _mount_); | ||
| ``` | ||
|
|
||
| ## Props | ||
|
|
||
| ## API | ||
|
|
||
| | 参数 | 说明 | 类型 | 默认值 | | ||
| |--------- |-------- |--------- |-------- | | ||
| | width | 宽度 | number | 400 | | ||
| | height | 高度 | number | 200 | | ||
| | position | 设置初始帧位置 | number | 0 | | ||
| | palyTime | 每帧停留时间(ms) | number | 2000 | | ||
| | scrollTime | 滚动动画的速度(ms) | number | 200 | | ||
| | autoPlay | 是否自动播放 | boolean | true | | ||
|
|
||
|
|
||
| ### ref | ||
|
|
||
| ```ts | ||
| // 跳转到指定帧 | ||
| gotoSlide: (slideNumber: number) => void; | ||
|
There was a problem hiding this comment. @nullptr-z Markdown 样式 格式化一下。 |
||
| // 上一针 | ||
| prevSlide: () => void; | ||
| // 下一帧 | ||
| nextSlide: () => void; | ||
| // 暂停播放 | ||
| stopPlay: () => void; | ||
| ``` | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| { | ||
| "name": "@uiw/react-carousel", | ||
| "version": "4.14.2", | ||
| "description": "Carousel component", | ||
| "homepage": "https://uiwjs.github.io/#/components/carousel", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/uiwjs/uiw.git" | ||
| }, | ||
| "license": "MIT", | ||
| "main": "cjs/index.js", | ||
| "module": "esm/index.js", | ||
| "files": [ | ||
| "dist.css", | ||
| "cjs", | ||
| "esm", | ||
| "src" | ||
| ], | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "keywords": [ | ||
| "carousel", | ||
| "design", | ||
|
|
||
| "uiw", | ||
| "uiw-react", | ||
| "react.js", | ||
| "react", | ||
| "react-component", | ||
| "component", | ||
| "components", | ||
| "ui", | ||
| "css", | ||
| "uikit", | ||
| "react-ui", | ||
| "framework", | ||
| "front-end", | ||
| "frontend" | ||
| ], | ||
| "peerDependencies": { | ||
| "react": ">=16.9.0", | ||
| "react-dom": ">=16.9.0" | ||
| }, | ||
| "dependencies": { | ||
| "@uiw/utils": "^4.14.2" | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| import React, { useEffect, useMemo, useRef, useState } from 'react'; | ||
| import { IProps, HTMLDivProps } from '@uiw/utils'; | ||
| import './style/index.less'; | ||
|
|
||
| export interface CarouselProps extends IProps, HTMLDivProps { | ||
| width?: number; | ||
| height?: number; | ||
| position?: number; | ||
| palyTime?: number; | ||
| scrollTime?: number; | ||
| autoPlay?: boolean; | ||
| } | ||
|
|
||
| export interface CarouselRef { | ||
| gotoSlide: (slide: number, dontAnimate?: boolean) => void; | ||
| prevSlide: () => void; | ||
| nextSlide: () => void; | ||
| stopPlay: () => void; | ||
| } | ||
|
|
||
| function Carousel(props: CarouselProps, ref: CarouselRef) { | ||
| const { | ||
| position = 0, | ||
| width = 400, | ||
| height = 200, | ||
| palyTime = 2000, | ||
| scrollTime = 200, | ||
| autoPlay = true, | ||
|
|
||
| prefixCls = 'w-carousel', | ||
| className, | ||
| style, | ||
| } = props; | ||
|
|
||
| const cls = useMemo(() => [prefixCls, className].filter(Boolean).join(' ').trim(), [prefixCls, className]); | ||
|
|
||
| const [currentPosition, currentPositionSet] = useState(position); | ||
| const positionRef = useRef(currentPosition); | ||
| const childCount = React.Children.count(props.children); | ||
| const stopPlay = useRef<Function>(() => {}); | ||
|
|
||
| React.useImperativeHandle( | ||
| ref, | ||
| () => ({ | ||
| gotoSlide, | ||
| prevSlide: () => gotoSlide(positionRef.current - 1), | ||
| nextSlide: () => gotoSlide(positionRef.current + 1), | ||
| stopPlay: () => stopPlay.current(), | ||
| }), | ||
| [ref], | ||
| ); | ||
|
|
||
| const gotoSlide = (slidNumber: number) => { | ||
| stopPlay.current(); | ||
| const maxSlid = childCount - 1; | ||
| let slidNumberTemp = slidNumber > maxSlid ? maxSlid : slidNumber; | ||
| slidNumberTemp = slidNumber < 0 ? 0 : slidNumberTemp; | ||
| positionRef.current = slidNumberTemp; | ||
| currentPositionSet(slidNumberTemp); | ||
| play(); | ||
| }; | ||
|
|
||
| const play = (ms: number = palyTime) => { | ||
| if (autoPlay) { | ||
| const time = setInterval(() => { | ||
| positionRef.current++; | ||
| if (positionRef.current >= childCount) { | ||
| positionRef.current = 0; | ||
| } | ||
| currentPositionSet(positionRef.current); | ||
| }, ms); | ||
| stopPlay.current = () => { | ||
| clearInterval(time); | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| useEffect(() => { | ||
| play(); | ||
| return () => { | ||
| stopPlay.current(); | ||
| }; | ||
| }, [autoPlay]); | ||
|
|
||
| return ( | ||
| <div className={cls} style={{ width, height }}> | ||
| <div | ||
| className={`${cls}-content`} | ||
| style={{ | ||
| width: width * childCount, | ||
| transform: `translate3d(${-(currentPosition * width)}px, 0px, 0px)`, | ||
| transition: `${scrollTime * 0.001}s ease-in-out`, | ||
| }} | ||
| > | ||
| {React.Children.map(props.children, (child) => { | ||
| return <div style={{ width, height, ...style }}>{child}</div>; | ||
| })} | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export default React.forwardRef<CarouselRef, CarouselProps>(Carousel); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| @w-carousel: ~'w-carousel'; | ||
|
|
||
| .@{w-carousel} { | ||
| overflow: hidden; | ||
|
|
||
| &-content { | ||
| height: 200px; | ||
| // transform: translate3d(); | ||
| display: flex; | ||
| flex-direction: row; | ||
| transition: 0.6s ease-in-out; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "extends": "../../tsconfig", | ||
| "include": ["src/**/*"], | ||
| "compilerOptions": { | ||
| "outDir": "./cjs", | ||
| "baseUrl": "." | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nullptr-z 添加安装文档，组件添加到
uiw包中。