用react實(shí)現(xiàn)一個簡單的scrollView組件

更新時間：2023年07月10日 10:00:07 作者：前端小張同學(xué)

這篇文章主要給大家介紹一下如何用 react 實(shí)現(xiàn)一個簡單的 scrollView組件，文中有詳細(xì)的代碼示例，具有一定的參考價值,需要的朋友可以參考下

效果

我們先看一下效果，大概就是希望點(diǎn)擊左邊按鈕或者右邊按鈕將元素以每一個子選項(xiàng)卡長度單位進(jìn)行精準(zhǔn)偏移。

設(shè)計(jì)考慮的問題

在這之前，大家不妨思考一下這個需求給到你，你應(yīng)該怎么去設(shè)計(jì)這個東西？

1 ：父盒子的長度多少？如何控制多出的元素隱藏？

2 ：我們應(yīng)該如何進(jìn)行偏移？用定位還是位移 ？他們有什么區(qū)別？如何保證偏移量一點(diǎn)不差？

3 ：每次偏移的量是多少？如何處理邊界情況？

好，帶著以下幾個問題，我們一起來思考一下這個組件，應(yīng)該如何封裝。

1：結(jié)構(gòu)

首先，結(jié)構(gòu)如下圖，我們有一個父盒子(content-wapper-hidden) ，還有一個子盒子內(nèi)嵌在父盒子中，父盒子負(fù)責(zé)元素的溢出隱藏，固定寬度，子盒子負(fù)責(zé)渲染，和滾動。

結(jié)構(gòu)搭建

scrollView.tsx

import { ReactNode, memo, useRef } from 'react'
import { ScrollViewWapper } from './style'
interface ScrollViewProps {
  children: ReactNode
}
const ScrollView = memo((
  {
    children
  }: ScrollViewProps
) => {
  const contentRef = useRef<HTMLDivElement>(null)
  return (
    <ScrollViewWapper>
      <div className='leftIcon'>左邊</div>
      <div className='content-wapper-hidden'>
        <div className='render-content' ref={contentRef}>
          {children}
        </div>
      </div>
      <div className='rightIcon'>右邊</div>
    </ScrollViewWapper>
  )
})
export default ScrollView

邏輯處理

1 ：接下來我們分別給兩個按鈕綁定事件，并且在初始化的時候去計(jì)算最大可偏移的值，

import { ReactNode, memo, useEffect, useRef, useState } from 'react'
import { ScrollViewWapper } from './style'
interface ScrollViewProps {
  children: ReactNode
}
const ScrollView = memo((
  {
    children
  }: ScrollViewProps
) => {
  const contentRef = useRef<HTMLDivElement>(null)
  const [maxoffset, setMaxOffset] = useState(0) // 兩者最大的偏移量 可滾動距離
  const [currentOffsetIndex, setCurrentOffsetIndex] = useState(0) // 當(dāng)前滾動元素的索引
  const handelIconClick = (isRoght: boolean) => {
  // 事件處理函數(shù) 
  }
  function getScrollOffset() {
    const scrollWidth = contentRef.current!.scrollWidth
    const clientWidth = contentRef.current!.clientWidth
    setMaxOffset(scrollWidth - clientWidth) // 計(jì)算最大偏移量
  }
  useEffect(() => {
    getScrollOffset()
  }, [])
  return (
    <ScrollViewWapper>
      <div className='leftIcon' onClick={() => handelIconClick(false)}>左邊</div>
      <div className='content-wapper-hidden'>
        <div className='render-content' ref={contentRef}>
          {children}
        </div>
      </div>
      <div className='rightIcon' onClick={() => handelIconClick(true)}>右邊</div>
    </ScrollViewWapper>
  )
})
export default ScrollView

在這里我們通過 ref 綁定了一個內(nèi)容元素，然后初始化的時候，我們?nèi)ビ?jì)算了元素最大可滾動的距離，然后當(dāng)我們點(diǎn)擊了按鈕時我們獲取了 contentRef 下所有綁定類名為 item的元素，點(diǎn)擊時判斷是否為右側(cè) 如果是右側(cè) 點(diǎn)擊則索引 + 1 否則索引 -1 ，然后做邊界處理，依次獲得item的 offsetLeft ，注意 offsetleft 是相對于父級元素的距離，然后將元素 contentRef 進(jìn)行 translate 位移

import { ReactNode, memo, useEffect, useRef, useState } from 'react'
import { ScrollViewWapper } from './style'
interface ScrollViewProps {
  children: ReactNode
}
const ScrollView = memo((
  {
    children
  }: ScrollViewProps
) => {
  const contentRef = useRef<HTMLDivElement>(null)
  const [maxoffset, setMaxOffset] = useState(0) // 兩者最大的偏移量 可滾動距離
  const [currentOffsetIndex, setCurrentOffsetIndex] = useState(0)
  const [isContinueScroll, setisContinueScroll] = useState(true)
  const handelIconClick = (isRight: boolean) => {
    const newIndex = isRight ? currentOffsetIndex + 1 : currentOffsetIndex - 1
    if (newIndex < 0 || (!isContinueScroll && isRight)) return // 邊界處理
    const TabAllList = getAllElements('item', 'class') // 獲取conntentRef 下面的 所有 item 子節(jié)點(diǎn)
    const TabItem = TabAllList[newIndex] as HTMLDivElement // 獲取下一個 準(zhǔn)備滾動元素
    const TabItemOffsetLeft = TabItem.offsetLeft
    contentRef.current!.style.transform = `translateX(${-TabItemOffsetLeft}px)`
    setisContinueScroll(maxoffset > TabItemOffsetLeft) // 是否能繼續(xù)滾動 如果 你的 offsetLeft 都
    // 比我可滾動距離大了 ， 則肯定是不能滾動的
    setCurrentOffsetIndex(newIndex)
  }
  const getAllElements = (querySelectorName: string, type: 'id' | 'class' | 'el' = 'class') => {
    let seletorName = null
    if (type === 'id') { // 對選擇器 做不同類型處理
      seletorName = `#${querySelectorName.replace(/\^#/, '')}`
    } else if (type == 'class') {
      seletorName = `.${querySelectorName.replace(/\^./, '')}`
    } else {
      seletorName = `${querySelectorName.replace(/\^(.|#)/, '')}`
    }
    return contentRef.current!.querySelectorAll(seletorName)
  }
  function getScrollOffset() {
    const scrollWidth = contentRef.current!.scrollWidth
    const clientWidth = contentRef.current!.clientWidth
    setMaxOffset(scrollWidth - clientWidth)
  }
  useEffect(() => {
    getScrollOffset()
  }, [])
  return (
    <ScrollViewWapper>
      <div className='leftIcon' onClick={() => handelIconClick(false)}>左邊</div>
      <div className='content-wapper-hidden'>
        <div className='render-content' ref={contentRef}>
          {children}
        </div>
      </div>
      <div className='rightIcon' onClick={() => handelIconClick(true)}>右邊</div>
    </ScrollViewWapper>
  )
})
export default ScrollView

外部使用ScrollView 組件

import classNames from 'classnames';
import { memo, useState } from 'react';
import ScrollView from './components';
const Login = memo(() => {
  const [list, setList] = useState(['YYDS', '易烊千璽', '李易峰', '雞哥', '古巨基', '羅志祥', '肖站', '彭于晏'])
  const [currentIndex, setCurrentIndex] = useState(0)
  return (
    <div id="danmu-container">
      <ScrollView>
        {
          list.map((item, index) => {
            return (
              <div className='item' key={item} onClick={() => setCurrentIndex(index)}>
                <div className={classNames('tab-item', currentIndex === index ? 'active' : '')}>{item}</div>
              </div>
            )
          })
        }
      </ScrollView>
    </div>
  )
})
export default Login