movable

介绍

movable 插件为 BetterScroll 拓展可移动拖拽的能力。

安装

npm install @better-scroll/movable --save

// or

yarn add @better-scroll/movable

基本使用

首先引入 movable 插件，并通过全局方法 BScroll.use() 注册插件

  import BScroll from '@better-scroll/core'
  import Movable from '@better-scroll/movable'

  BScroll.use(Movable)

上面步骤完成后，需要在 options 中传入正确的配置：

new BScroll('.bs-wrapper', {
  bindToTarget: true,
  scrollX: true,
  scrollY: true,
  freeScroll: true,
  bounce: true
  movable: true // for movable plugin
})

以下是移动插件专属以及 BetterScroll 的配置：

• movable<插件专属>

  开启 movable 功能，必须设置为 true，若没有该项，则插件不会生效。

• bindToTarget

  必须设置为 true，主动将 touch 事件绑定在待移动的元素上，因为BetterScroll 默认将 touch 事件在绑定容器元素（wrapper）上。

• freeScroll

  记录 x 和 y 轴的手指偏移量，设置为 true。同时需要设置 scrollX 和 scrollY 均为 true。

• scrollX

  开启 x 轴方向滚动能力，设置为 true。

• scrollY

  开启 y 轴方向滚动能力，设置为 true。

• bounce

  指定开启边界回弹。

  • 示例

      {
        bounce: true // 开启四个方向,
        bounce: {
          left: true, // 开启左边界回弹
          right: true, // 开启右边界回弹
          top: false,
          bottom: false
        }
      }
    

示例

• 只有一个 content

  通常场景下，只存在一个 content。

  <template>
    <div class="movable-container">
      <div class="scroll-wrapper" ref="scroll">
        <div class="scroll-content">
          <div class="scroll-item" v-for="(item, index) in emojis" :key="index">{{item}}</div>
        </div>
      </div>
    </div>
  </template>

  <script type="text/ecmascript-6">
    import BScroll from '@better-scroll/core'
    import Movable from '@better-scroll/movable'
  
    BScroll.use(Movable)
  
    export default {
      data () {
        return {
          emojis: [
            '😀 😁 😂 🤣 😃',
            '😄 😅 😆 😉 😊',
            '😫 😴 😌 😛 😜',
            '👆🏻 😒 😓 😔 👇🏻'
          ]
        }
      },
      mounted() {
        this.init()
      },
      beforeDestroy() {
        this.bs.destroy()
      },
      methods: {
        init() {
          this.bs = new BScroll(this.$refs.scroll, {
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            startX: 20,
            startY: 20
          })
        }
      }
    }
  </script>

  <style lang="stylus" rel="stylesheet/stylus" scoped>
  
  .movable-container
    .scroll-wrapper
      height 400px
      overflow hidden
      box-shadow 0 0 3px rgba(0, 0, 0, .3)
      .scroll-content
        width 220px
      .scroll-item
        height 50px
        line-height 50px
        font-size 24px
        font-weight bold
        border-bottom 1px solid #eee
        text-align center
        &:nth-child(2n)
          background-color #f3f5f7
        &:nth-child(2n+1)
          background-color #42b983
  </style>

• 多个 content

  但是在某些场景下，可能存在多个 content。

  <template>
    <div class="movable-multi-content-container">
      <div class="scroll-wrapper" ref="scroll">
        <div class="scroll-content content1">
          <figure>
            <figcaption>Cold Oasis</figcaption>
            <img class="picture" src="./images/oasis_one.webp"
           alt="Cold Oasis">
          </figure>
        </div>
        <div class="scroll-content content2">
          <figure>
            <figcaption>Warm Oasis</figcaption>
            <img class="picture" src="./images/oasis_two.webp"
           alt="Warm Oasis">
          </figure>
        </div>
      </div>
      <button class="btn" @click="handleClick">Put The Warm at center position</button>
    </div>
  </template>

  <script type="text/ecmascript-6">
    import BScroll from '@better-scroll/core'
    import Movable from '@better-scroll/movable'
  
    BScroll.use(Movable)
  
    export default {
      mounted() {
        this.init()
      },
      beforeDestroy() {
        this.bs1.destroy()
        this.bs2.destroy()
      },
      methods: {
        init() {
          this.bs1 = new BScroll(this.$refs.scroll, {
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            startX: 10,
            startY: 10
          })
          this.bs2 = new BScroll(this.$refs.scroll, {
            // use wrapper.children[1] as content
            specifiedIndexAsContent: 1,
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            startX: 0,
            startY: 170
          })
        },
        handleClick() {
          this.bs2.putAt('center', 'center')
        }
      }
    }
  </script>

  <style lang="stylus" rel="stylesheet/stylus" scoped>
  
  .movable-multi-content-container
  
    .scroll-wrapper
      height 400px
      overflow hidden
      position relative
      box-shadow 0 0 3px rgba(0, 0, 0, .3)
      .scroll-content
        position absolute
        top 0
        left 0
        width 200px
        figure
          margin 0
        figcaption
          font-weight bold
          margin-bottom 5px
          text-align center
          color #ea4c89
        .picture
          width 200px
          height 150px
          border-radius 10px
      .scroll-item
        height 50px
        line-height 50px
        font-size 24px
        font-weight bold
        border-bottom 1px solid #eee
        text-align center
        &:nth-child(2n)
          background-color #f3f5f7
        &:nth-child(2n+1)
          background-color #42b983
  
    .btn
      margin 40px auto
      padding 10px
      color #fff
      border-radius 4px
      font-size 20px
      background-color #666          
  </style>

进阶使用

搭配 zoom 插件，增加缩放能力。

  import BScroll from '@better-scroll/core'
  import Movable from '@better-scroll/movable'
  import Zoom from '@better-scroll/zoom'
  new BScroll('.bs-wrapper', {
    bindToTarget: true,
    scrollX: true,
    scrollY: true,
    freeScroll: true,
    bounce: true
    movable: true // for movable plugin
    zoom: { // for zoom plugin
      start: 1,
      min: 1,
      max: 3
    }
  })

示例

WARNING

zoom 暂不支持在 pc 端的交互操作，下方 demo 请扫码体验。

• 一个 content

  <template>
    <div class="core-container">
      <div class="scroll-wrapper" ref="scroll">
        <div class="scroll-content">
          <div class="scroll-item" v-for="(item, index) in emojis" :key="index">{{item}}</div>
        </div>
      </div>
    </div>
  </template>

  <script type="text/ecmascript-6">
    import BScroll from '@better-scroll/core'
    import Movable from '@better-scroll/movable'
    import Zoom from '@better-scroll/zoom'
  
    BScroll.use(Movable)
    BScroll.use(Zoom)
  
    export default {
      data () {
        return {
          emojis: [
            '😀 😁 😂 🤣 😃',
            '😄 😅 😆 😉 😊',
            '😫 😴 😌 😛 😜',
            '👆🏻 😒 😓 😔 👇🏻'
          ]
        }
      },
      mounted() {
        this.init()
      },
      beforeDestroy() {
        this.bs.destroy()
      },
      methods: {
        init() {
          this.bs = new BScroll(this.$refs.scroll, {
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            zoom: {
              start: 1,
              min: 0.5,
              max: 3
            }
          })
        }
      }
    }
  </script>

  <style lang="stylus" rel="stylesheet/stylus" scoped>
  
  .core-container
    .scroll-wrapper
      height 400px
      overflow hidden
      box-shadow 0 0 3px rgba(0, 0, 0, .3)
      .scroll-content
        width 220px
      .scroll-item
        height 50px
        line-height 50px
        font-size 24px
        font-weight bold
        border-bottom 1px solid #eee
        text-align center
        &:nth-child(2n)
          background-color #f3f5f7
        &:nth-child(2n+1)
          background-color #42b983
  </style>

• 多个 content

  <template>
    <div class="movable-multi-content-scale-container">
      <div class="scroll-wrapper" ref="scroll">
        <div class="scroll-content content1">
          <figure>
            <figcaption>Swordsman</figcaption>
            <img class="picture" src="./images/ftstr.webp"
           alt="ftstr">
          </figure>
        </div>
        <div class="scroll-content content2">
          <figure>
            <figcaption>The Witch</figcaption>
            <img class="picture" src="./images/qos_crop.webp"
           alt="qos_crop">
          </figure>
        </div>
      </div>
      <button class="btn" @click="handleClick">Put The Witch at right-bottom corner</button>
    </div>
  </template>

  <script type="text/ecmascript-6">
    import BScroll from '@better-scroll/core'
    import Movable from '@better-scroll/movable'
    import Zoom from '@better-scroll/zoom'
  
    BScroll.use(Movable)
    BScroll.use(Zoom)
  
    export default {
      mounted() {
        this.init()
      },
      beforeDestroy() {
        this.bs1.destroy()
        this.bs2.destroy()
      },
      methods: {
        handleClick() {
          this.bs2.putAt('right', 'bottom', 500)
        },
        init() {
          this.bs1 = new BScroll(this.$refs.scroll, {
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            zoom: {
              start: 1.2,
              min: 0.5,
              max: 3
            }
          })
          this.bs1.putAt('center', 'center', 0)
          this.bs2 = new BScroll(this.$refs.scroll, {
            specifiedIndexAsContent: 1,
            bindToTarget: true,
            scrollX: true,
            scrollY: true,
            freeScroll: true,
            movable: true,
            startY: 150,
            zoom: {
              start: 1,
              min: 0.5,
              max: 3
            }
          })
        }
      }
    }
  </script>

  <style lang="stylus" rel="stylesheet/stylus" scoped>
  
  .movable-multi-content-scale-container
  
    .scroll-wrapper
      height 400px
      overflow hidden
      position relative
      box-shadow 0 0 3px rgba(0, 0, 0, .3)
      .scroll-content
        position absolute
        top 0
        left 0
        width 200px
        figure
          margin 0
        figcaption
          font-weight bold
          margin-bottom 5px
          text-align center
          color #ea4c89
        .picture
          width 200px
          height 150px
          border-radius 10px
      .scroll-item
        height 50px
        line-height 50px
        font-size 24px
        font-weight bold
        border-bottom 1px solid #eee
        text-align center
        &:nth-child(2n)
          background-color #f3f5f7
        &:nth-child(2n+1)
          background-color #42b983
  
    .btn
      margin 40px auto
      padding 10px
      color #fff
      border-radius 4px
      font-size 20px
      background-color #666  
  </style>

实例方法

putAt(x, y, [time], [easing])^(2.0.4)

• 参数

  • {PositionX} x： x 坐标
    • PositionX：'number | 'left' | 'right' | 'center'
  • {PositionY} y： y 坐标
    • PositionY：'number | 'top' | 'bottom' | 'center'
  • {number} [time]<可选>：滚动的动画时长
  • {EaseItem} [easing]<可选>：缓动效果配置，参考 ease.ts，默认是 bounce 效果

  将 content 元素放置在某一个位置。x 与 y 不仅可以是数字，也可以是对应的字符串。

• 示例

const bs = new BScroll('.bs-wrapper', {
  bindToTarget: true,
  scrollX: true,
  scrollY: true,
  freeScroll: true,
  movable: true
})

bs.putAt('center', 'center', 0) // 放置在 wrapper 的正中心
bs.putAt('right', 'bottom', 1000) // 放置在 wrapper 的右下角，动画时长 1s