1.0.0 • Published 4 years ago

simple-vue-swiper v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

simple-vue-swiper

swiper component. Easy to use. Base on vue-swiper

demo

simple-vue-swiper

how to use

yarn add simple-vue-swiper # or npm i simple-vue-swiper -swiper
<template>
  ...
  <swiper
    direction="horizontal"
    :mousewheel-control="true"
    :performance-mode="false"
    :pagination-visible="true"
    :pagination-clickable="true"
    :loop="true"
    @slide-change-start="onSlideChangeStart"
    @slide-change-end="onSlideChangeEnd"
    @slide-revert-start="onSlideRevertStart"
    @slide-revert-end="onSlideRevertEnd"
    @slider-move="onSliderMove"
  >
    <div>page one</div>
    <div>page two</div>
    <div>page three</div>
    <div>page four</div>
    <div>page five</div>
  </swiper>
  ...
</template>

<script>
import Swiper from 'simple-vue-swiper'
export default {
  components: {
    Swiper
  },
  methods: {
    onSlideChangeStart: function(currentPage) {
      console.log("onSlideChangeStart", currentPage);
    },
    onSlideChangeEnd: function(currentPage) {
      console.log("onSlideChangeEnd", currentPage);
    },
    onSlideRevertStart: function(currentPage) {
      console.log("onSlideRevertStart", currentPage);
    },
    onSlideRevertEnd: function(currentPage) {
      console.log("onSlideRevertEnd", currentPage);
    },
    onSliderMove: function(offset) {
      console.log("onSliderMove", offset);
    },
  }
}
</script>

Api

Properties

NameTypeDefaultDescription
directionString"vertical"Could be 'horizontal' or 'vertical' (for vertical slider).
mousewheel-controlBooleantrueSet to true to enable navigation through slides using mouse wheel.
pagination-visibleBooleanfalseToggle (hide/true) pagination container visibility when click on Slider's container
pagination-clickableBooleanfalseIf true then clicking on pagination button will cause transition to appropriate slide.
performace-modeBooleanfalseDisable advance effect for better performance.
loopBooleanfalseSet to true to enable continuous loop mode
============================================================

Methods

MethodDescription
next()Go next page.
prev()Go previous page.
setPage(Number)Set current page number.

Events

NameParametersDescription
slide-change-startpageNumberFire in the beginning of animation to other slide (next or previous).
slide-change-endpageNumberWill be fired after animation to other slide (next or previous).
slide-revert-startpageNumberFire in the beginning of animation to revert slide (no change).
slide-revert-endpageNumberWill be fired after animation to revert slide (no change).
slider-moveoffsetCallback function, will be executed when user touch and move finger over Swiper and move it. Receives swiper instance and 'touchmove' event as an arguments.
==============================================================