Skip to content

Commit bc864be

Browse files
committed
Update file: touchswipe-jquery-plugin-by-mattbryson.html
1 parent 4a1fb7f commit bc864be

File tree

1 file changed

+83
-2
lines changed

1 file changed

+83
-2
lines changed

jquery-plugins/touchswipe-jquery-plugin-by-mattbryson.html

Lines changed: 83 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,93 @@ <h1 id="packageName">Touchswipe Jquery Plugin</h1>
174174
</div>
175175
<div class="tab-content mt-3" id="infoTabsContent">
176176
<div class="tab-pane fade show active" id="installation" role="tabpanel" aria-labelledby="installation-tab">
177-
No README available
177+
# TouchSwipe 1.6
178+
A jQuery plugin to be used on touch devices such as iPad, iPhone, Android etc.
179+
180+
Detects single and multiple finger swipes, pinches and falls back to mouse 'drags' on the desktop.
181+
182+
Time and distance thresholds can be set to distinguish between swipe gesture and slow drag.
183+
184+
Allows exclusion of child elements (interactive elements) as well allowing page scrolling or page zooming depending on configuration.
185+
186+
* Detects swipes in 4 directions, "up", "down", "left" and "right"
187+
* Detects pinches "in" and "out"
188+
* Supports single finger or double finger touch events
189+
* Supports click events both on the touchSwipe object and its child objects
190+
* Definable threshold / maxTimeThreshold to determin when a gesture is actually a swipe
191+
* Events triggered for swipe "start","move","end" and "cancel"
192+
* End event can be triggered either on touch release, or as soon as threshold is met
193+
* Allows swiping and page scrolling
194+
* Disables user input elements (Button, form, text etc) from triggering swipes
195+
196+
## Demos, examples and docs
197+
198+
[http://labs.rampinteractive.co.uk/touchSwipe](http://labs.rampinteractive.co.uk/touchSwipe)
199+
[http://labs.rampinteractive.co.uk/touchSwipe/docs](http://labs.rampinteractive.co.uk/touchSwipe/docs)
200+
201+
202+
## Installation
203+
### NPM
204+
````bash
205+
npm install jquery-touchswipe --save
206+
````
207+
### Bower
208+
````bash
209+
bower install jquery-touchswipe --save
210+
````
211+
### Manual
212+
Include the minified file in your project.
213+
````html
214+
<script type="text/javascript" src="js/jquery.touchSwipe.min.js"></script>
215+
````
216+
217+
## Usage
218+
````javascript
219+
$(function() {
220+
$("#test").swipe( {
221+
//Generic swipe handler for all directions
222+
swipe:function(event, direction, distance, duration, fingerCount, fingerData) {
223+
$(this).text("You swiped " + direction );
224+
}
225+
});
226+
227+
//Set some options later
228+
$("#test").swipe( {fingers:2} );
229+
});
230+
````
231+
232+
For full demos, code examples and documentation, see below.
233+
234+
235+
## Development
236+
Install dependencies
237+
````bash
238+
npm install
239+
````
240+
241+
To minify
242+
````bash
243+
npm run minify
244+
````
245+
246+
To build docs
247+
````bash
248+
npm run docs
249+
````
250+
251+
To do both
252+
````bash
253+
npm run build
254+
````
255+
256+
### For port to XUI see:
257+
https://github.com/cowgp/xui-touchSwipe
258+
178259
</div>
179260

180261
<div class="tab-pane fade" id="changelog" role="tabpanel" aria-labelledby="changelog-tab">
181262
<ul id="changelogList">
182-
No changelog available.
263+
{"message":"Not Found","documentation_url":"https://docs.github.com/rest/repos/contents#get-repository-content","status":"404"}
183264
</ul>
184265
</div>
185266

0 commit comments

Comments
 (0)