什么是useSwipeable?一个让你轻易实现滑动效果的Hook

最近发现一个React非常好的用的滑动事件处理的钩子组件

Hook details

  • 钩子的使用需要react>=16.8.0
  • handlers中包含的道具当前是refonMouseDown请展开handlers,因为其中包含的道具可能会随着react提高事件侦听能力而改变

使用之前需要安装包

  • npm i react-swipeable

引入我们的hook

import { useSwipeable } from 'react-swipeable'

我们先来看看这个钩子接收的参数

  • 第一个参数: 对象的形式写上对应事件的处理函数
perl 复制代码
{
  onSwiped,       // 任何方向滑动触发 (SwipeEventData) => void
  onSwipedLeft,   // 向左滑动触发 (SwipeEventData) => void
  onSwipedRight,  // 向右滑动触发 (SwipeEventData) => void
  onSwipedUp,     // 向上滑动触发 (SwipeEventData) => void
  onSwipedDown,   // 向下滑动触发  (SwipeEventData) => void
  onSwipeStart,   // 滑动开始时触发 (SwipeEventData) => void *see details*
  onSwiping,      // 滑动过程中触发 (SwipeEventData) => void
  onTap,          // After a tap ({ event }) => void

  // 传递回调,提供事件: ({ event }) => void
  onTouchStartOrOnMouseDown, // 需要 'touchstart' 和 'mousedown'
  onTouchEndOrOnMouseUp,     // 需要 `touchend` 和 `mouseup`
}

详细细节

OnSwipeStart-每次开始时只调用一次,在第一个onSwiping回调之前,SwipeEventData的第一个属性将为真

  • 第二个参数: 关于滑动需要使用到的配置
ts 复制代码
{
  delta: 10,                             // 开始滑动的最小距离 单位(px)
  preventScrollOnSwipe: false,           // 在滑动的时候是否防止滚动
  trackTouch: true,                      // 是否使用触摸滑动
  trackMouse: false,                     // 是否使用光标滑动
  rotationAngle: 0,                      // 设置旋转角度
  swipeDuration: Infinity,               // 允许的滑动时间 单位(ms)
  touchEventOptions: { passive: true },  // 触摸监听器的选项
}

详细细节

触摸监听器的配置不详细展开了可以去参考官方文档 链接贴在下面了

react-swipeable - npm (npmjs.com)

了解完这些不废话了直接上代码

  • 这边我使用的案例 拓展antd的Tabs组件去支持滑动切换
tsx 复制代码
import { Tabs } from 'antd';
import { useSwipeable } from 'react-swipeable'; //引入useSwipeable

const { TabPane } = Tabs;

function SwipeableTabs() {
  const [activeKey, setActiveKey] = useState(1);
  // 使用useSwipeable
  const handlers = useSwipeable({
    // 记得增加边界判断 比如activeKey >= 0 
    onSwipedLeft: () => setActiveKey(prevKey + 1),
    onSwipedRight: () => setActiveKey(prevKey - 1)
    // 开启鼠标控制滑动
    trackMouse: true
  });

  return (
      {/* 展开使用 */}
      <div {...handlers}>
       <Tabs activeKey={activeKey} >
          <TabPane tab="Tab 1" key="1">
            Content of Tab Pane 1
          </TabPane>
          <TabPane tab="Tab 2" key="2">
            Content of Tab Pane 2
          </TabPane>
          <TabPane tab="Tab 3" key="3">
            Content of Tab Pane 3
          </TabPane>
        </Tabs>
      </div>
  );
}

最后就简单的实现了一个滑动的效果了 🤞

相关推荐
只会cv的前端攻城狮1 分钟前
动态组件架构设计:从配置到事件驱动全链路解析
前端·vue.js
飞天狗2 分钟前
Next.js 16 App Router 实战:服务端组件与流式渲染
前端·next.js
OpenTiny社区7 分钟前
TinyEngine 2.11版本发布:AI 进一步融入画布,Vue 工程可一键转DSL
前端·vue.js·github
小雪_Snow22 分钟前
JavaScript 中的三种常用事件
开发语言·前端·javascript
Hyyy24 分钟前
Electron-Vite是什么,和Vite有什么区别
前端·面试
蓝胖子酱37 分钟前
在 Electron 中用 electron-store 实现加密存储与自定义格式文件
前端·javascript·数据库
虚焦像素_40 分钟前
海康 Web 插件版接入指南:用法与注意事项
前端
虚焦像素_1 小时前
海康 Web 无插件版接入指南:用法与注意事项
前端
aaron2 小时前
前端演进史:当你没留意时,前端发生了什么
前端
不好听6132 小时前
前端路由完全指南(上篇):从原理到 6 种路由模式
前端·react.js