npm 包 @tplusrex/cn-react-slick 使用教程

阅读时长 7 分钟读完

概述

@tplusrex/cn-react-slick 是一个用于 React 框架的轮播组件库,可以帮助你轻松快捷地实现滑动轮播、响应式布局、自定义样式和动画等功能。该库支持无限循环、自动播放和手动滑动等多种操作,并且拥有众多可配置项,可以满足大部分轮播需求。

安装

使用 Node.js 的 npm 包管理工具进行安装:

使用

在 React 项目中导入组件并配置参数即可使用:

-- -------------------- ---- -------
------ ------ ---- ---------------------------

----- -------- - -
  ----- -----
  --------- -----
  ------ ----
  ------------- --
  --------------- -
--

-------- ----- -
  ------ -
    ------- --------------
      -----
        ----------
      ------
      -----
        ----------
      ------
      -----
        ----------
      ------
      -----
        ----------
      ------
      -----
        ----------
      ------
      -----
        ----------
      ------
    ---------
  --
-

参数

可以通过 settings 对象来设定组件的参数,以下是可配置项的详细解释:

  • accessibility:是否启用键盘导航功能,默认为 true
  • adaptiveHeight:是否根据轮播内容的高度自动调整容器高度,默认为 false
  • autoplay:是否启用自动播放功能,默认为 false
  • autoplaySpeed:自动播放的间隔时间,单位为毫秒,默认为 3000
  • arrows:是否显示上下翻页箭头,默认为 true
  • centerMode:是否启用居中模式,默认为 false
  • centerPadding:居中模式时左右两边的容器内边距,单位为像素,默认为 '50px'
  • cssEase:动画效果名称,支持 'linear', 'ease', 'ease-in', 'ease-out', 'ease-in-out', 'cubic-bezier(n, n, n, n)' 等多种效果,默认为 'ease'
  • dots:是否显示轮播指示器,默认为 false
  • dotsClass:轮播指示器容器的类名,默认为 slick-dots
  • draggable:是否启用鼠标拖拽滑动功能,默认为 true
  • easing:同 cssEase
  • edgeFriction:边缘弹性系数,取值范围为 01,默认为 0.15
  • fade:是否启用淡入淡出效果,默认为 false
  • focusOnSelect:是否在切换时自动选中中心的滑块,默认为 false
  • infinite:是否循环滑动,默认为 true
  • initialSlide:初始化时显示的滑块索引,默认为 0
  • lazyLoad:是否启用懒加载效果,默认为 false
  • nextArrow:上一页箭头元素,接受一个 React 组件。
  • pauseOnDotsHover:是否在悬浮时停止自动播放,默认为 false
  • pauseOnFocus:是否在焦点切换时停止自动播放,默认为 false
  • pauseOnHover:是否在悬浮时停止自动播放,默认为 true
  • prevArrow:下一页箭头元素,接受一个 React 组件。
  • responsive:响应式布局参数,接受一个数组,数组元素为一个对象,可配置 breakpoint(断点宽度)、settings(配置参数)和 originalSettings(原始参数)。
  • rows:每行滑块数,默认为 1
  • rtl:是否开启从右向左(RTL)模式,启用后箭头朝左、指示器居右,默认为 false
  • slide:轮播模式,支持 'css'(使用 CSS3 动画)和 'fade'(淡入淡出)两种模式,默认为 'slide'
  • slidesPerRow:每行容器内的滑块个数,默认为 1
  • slidesToScroll:每次滑动的滑块个数,默认为 1
  • slidesToShow:每屏显示的滑块个数,默认为 1
  • speed:滑动速度,单位为毫秒,默认为 300
  • swipe:是否启用触摸屏滑动功能,默认为 true
  • swipeToSlide:是否启用滑动到指定滑块索引的功能,默认为 false
  • touchMove:是否启用滑动鼠标中键时缩放滑块功能,默认为 true
  • touchThreshold:触摸屏滑动时的触发阈值,单位为像素,默认为 5
  • useCSS:是否使用 CSS3 动画效果进行滑动,建议在一些不支持动画的浏览器上关闭,默认为 true
  • variableWidth:是否启用非固定宽度滑块容器功能,默认为 false
  • vertical:是否启用纵向滑动功能,默认为 false
  • verticalSwiping:纵向滑动时每次滑动的滑块数,默认为 1

示例

以下是一个使用 @tplusrex/cn-react-slick 库创建的轮播图组件示例,可供您参考:

-- -------------------- ---- -------
------ ----- ---- --------
------ ------ ---- ---------------------------

----- -------- - -
  ------- ------
  --------- -----
  -------------- -----
  --------- -----
  ------ ----
  ------------- --
  ----------- -
    -
      ----------- -----
      --------- -
        ------------- --
        --------------- --
        --------- -----
        ----- ----
      -
    --
    -
      ----------- ----
      --------- -
        ------------- --
        --------------- --
        ------------- -
      -
    --
    -
      ----------- ----
      --------- -
        ------------- --
        --------------- -
      -
    -
  -
--

-------- ----- -
  ------ -
    ------- --------------
      -----
        ---- -------------- ------ --
      ------
      -----
        ---- -------------- ------ --
      ------
      -----
        ---- -------------- ------ --
      ------
      -----
        ---- -------------- ------ --
      ------
      -----
        ---- -------------- ------ --
      ------
      -----
        ---- -------------- ------ --
      ------
    ---------
  --
-

------ ------- ----

结论

@tplusrex/cn-react-slick 是 React 框架中一款非常强大的轮播组件,拥有丰富的配置项和灵活多变的布局模式。使用这个库可以方便地实现各种类型的轮播功能,并且由于其支持多种动画效果,可以让页面更具有吸引力。可以用来美化网站、展示产品、彰显品牌等用途,值得进一步探究和使用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055b1d81e8991b448d8c65

纠错
反馈