@pluginjs/swipe NPM

Swipe

A flexible modern swipe js plugin.

Introduction

Installation

Yarn

yarn add @pluginjs/swipe

NPM

npm i @pluginjs/swipe

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/swipe/dist/swipe.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/swipe/dist/swipe.css">

Production:

<script src="https://unpkg.com/@pluginjs/swipe/dist/swipe.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/swipe/dist/swipe.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Swipe from "@pluginjs/swipe"
import "@pluginjs/swipe/dist/swipe.css"

Swipe.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/swipe/dist/swipe.css")
const Swipe = require("@pluginjs/swipe")

Swipe.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/swipe/dist/swipe.css">
<script src="https://unpkg.com/@pluginjs/swipe/dist/swipe.js"></script>
<script>
  Pj.swipe('.element', options)
</script>

API

Options

Options are called on swipe instances through the swipe options itself. You can also save the instances to variable for further use.

Name	Description	Default
`"theme"`	Add plugin theme option	`null`
`"locale"`	Set locale	`en`
`"wrapperSelector"`	Wrapper selector	`null`
`"containerSelector"`	Container selector	`null`
`"itemSelector"`	Item selector	`div`
`"arrows"`	Active arrows	`false`
`"arrowConfig"`	Arrows config	`false`
`"pagination"`	Active pagination	`false`
`"drag"`	Support drag	`true`
`"dragFree"`	Support dragfree	`false`
`"power"`	Dragfree power	`2`
`"group"`	Group	`false`
`"loop"`	Active loop mode	`false`
`"multiple"`	Active multiple mode	`false`
`"center"`	Set center model	`false`
`"itemNums"`	Number of swipe per column	`1`
`"gutter"`	'10px 10px' => 'top&bottom left&right', 10 => top&bottom&left&right	`0`
`"height"`	Set swipe height	`100%`
`"advanced"`	Advance options	`{ getItemInstances: null, computeItemLocation: null, computeWidthResize: null }`
`"defaultActive"`	default index of active item	`0`
`"duration"`	Set duration	`400`
`"templates"`	HTML template engine	`{ wrapper, container, pagination, arrow: (prev, next) }`

Events

Events are called on swipe instances through the swipe events itself. You can also save the instances to variable for further use.

Name	Description
`"update"`	Gets fired when plugin is update
`"ready"`	Gets fired when plugin is ready
`"enable"`	Gets fired when plugin is enabled
`"disable"`	Gets fired when plugin is disabled
`"destroy"`	Gets fired when plugin is destroy
`"change"`	Gets fired when plugin has change
`"next"`	Gets fired when plugin has next
`"prev"`	Gets fired when plugin has goes prev
`"dragStart"`	Gets fired when plugin has be dragStart
`"dragEnd"`	Gets fired when plugin has be dragEnd
`"moveEnd"`	Gets fired when plugin has be moveEnd
`"resize"`	Gets fired when plugin has be resize

Methods

Methods are called on swipe instances through the swipe method itself. You can also save the instances to variable for further use.

Name	Description
`"disable"`	Disable plugin
`"enable"`	Enabled plugin if plugin is disabled
`"destroy"`	Destroy plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-swipe "THEME" | Declare plugin theme | {namespace}--{theme} "WRAPPER" | Declare wrapper node | {namespace}-wrapper "CONTAINER" | Declare container node | {namespace}-container "ITEM" | Declare item node | {namespace}-item "PAGINATION" | Declare pagination node | {namespace}-pagination "PAGINATIONITEM" | Declare pagination item node | {namespace}-pagination-item "ACTIVE" | Declare active status | {namespace}-active

Browser support

Tested on all major browsers.

IE / Edge	Firefox	Chrome	Safari	Opera
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

@pluginjs/swipe is Licensed under the GPL-v3 license.

If you want to use @pluginjs/swipe project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us purchase@thecreation.co.