Skip to content

Commit

Permalink
⬆️ cellSelect -> select for Flickity v2; v2.0.0
Browse files Browse the repository at this point in the history
+ update UMD
+ gallery -> carousel
  • Loading branch information
desandro committed Jul 22, 2016
1 parent fa61a69 commit 96c64be
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 45 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Enables `sync` option for [Flickity](http://flickity.metafizzy.co/)
You can sync two Flickity galleries. Whenever one selects a cell, its companion will select its cell of the same index.

``` html
<div class="gallery gallery-a">
<div class="carousel carousel-a">
...
</div>
<div class="gallery gallery-b">
<div class="carousel carousel-b">
...
</div>
```

``` js
// options
sync: 'gallery-b'
sync: 'carousel-b'
// set as a selector string

sync: document.querySelector('gallery-b')
sync: document.querySelector('carousel-b')
// set as an element
```

Expand All @@ -27,30 +27,30 @@ sync: document.querySelector('gallery-b')
### jQuery

``` js
$('.gallery-a').flickity({
sync: 'gallery-b'
$('.carousel-a').flickity({
sync: 'carousel-b'
});
// only need to set sync on one of the Flickity galleries
$('.gallery-b').flickity();
$('.carousel-b').flickity();
```

### Vanilla JS

``` js
var flktyA = new Flickity( '.gallery-a', {
sync: '.gallery-b'
var flktyA = new Flickity( '.carousel-a', {
sync: '.carousel-b'
});
var flktyB = new Flickity('.gallery-b');
var flktyB = new Flickity('.carousel-b');
```

### HTML

``` html
<div class="gallery gallery-a js-flickity"
data-flickity-options='{ "sync": ".gallery-b" }'>
<div class="carousel carousel-a js-flickity"
data-flickity-options='{ "sync": ".carousel-b" }'>
...
</div>
<div class="gallery gallery-b js-flickity">
<div class="carousel carousel-b js-flickity">
...
</div>
```
Expand All @@ -67,10 +67,10 @@ npm: `npm install flickity-sync`

``` js
requirejs( [ 'path/to/flickity-sync' ], function( Flickity ) {
var flktyA = new Flickity( '.gallery-a', {
sync: '.gallery-b'
var flktyA = new Flickity( '.carousel-a', {
sync: '.carousel-b'
});
var flktyB = new Flickity('.gallery-b')
var flktyB = new Flickity('.carousel-b')
});
```

Expand All @@ -79,10 +79,10 @@ requirejs( [ 'path/to/flickity-sync' ], function( Flickity ) {
``` js
var Flickity = require('flickity-sync');

var flktyA = new Flickity( '.gallery-a', {
sync: '.gallery-b'
var flktyA = new Flickity( '.carousel-a', {
sync: '.carousel-b'
});
var flktyB = new Flickity('.gallery-b');
var flktyB = new Flickity('.carousel-b');
```

---
Expand Down
5 changes: 2 additions & 3 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{
"name": "flickity-sync",
"version": "1.0.1",
"description": "Enable sync for Flickity",
"main": "flickity-sync.js",
"dependencies": {
"flickity": "^1.0.0",
"fizzy-ui-utils": "^1.0.0"
"flickity": "^2.0.0",
"fizzy-ui-utils": "^2.0.0"
},
"devDependencies": {
"qunit": "~1.17.1"
Expand Down
20 changes: 7 additions & 13 deletions flickity-sync.js
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
/*!
* Flickity sync v1.0.1
* Flickity sync v2.0.0
* enable sync for Flickity
*/

/*jshint browser: true, undef: true, unused: true, strict: true*/

( function( window, factory ) {
/*global define: false, module: false, require: false */
'use strict';
// universal module definition

/*jshint strict: false */ /*globals define, module, require */
if ( typeof define == 'function' && define.amd ) {
// AMD
define( [
'flickity/js/index',
'fizzy-ui-utils/utils'
], function( Flickity, utils ) {
return factory( window, Flickity, utils );
});
} else if ( typeof exports == 'object' ) {
], factory );
} else if ( typeof module == 'object' && module.exports ) {
// CommonJS
module.exports = factory(
window,
require('flickity'),
require('fizzy-ui-utils')
);
} else {
// browser global
window.Flickity = factory(
window,
window.Flickity,
window.fizzyUIUtils
);
}

}( window, function factory( window, Flickity, utils ) {
}( window, function factory( Flickity, utils ) {

'use strict';

Expand Down Expand Up @@ -87,7 +81,7 @@ Flickity.prototype._syncCompanion = function( companion ) {
companion.select( index );
}
}
this.on( 'cellSelect', syncListener );
this.on( 'select', syncListener );
// keep track of all synced flickities
// hold on to listener to unsync
this.syncers[ companion.guid ] = {
Expand Down Expand Up @@ -124,7 +118,7 @@ Flickity.prototype._unsync = function( companion ) {
Flickity.prototype._unsyncCompanion = function( companion ) {
var id = companion.guid;
var syncer = this.syncers[ id ];
this.off( 'cellSelect', syncer.listener );
this.off( 'select', syncer.listener );
delete this.syncers[ id ];
};

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "flickity-sync",
"version": "1.0.1",
"version": "2.0.0",
"description": "Enable sync for Flickity",
"main": "flickity-sync.js",
"dependencies": {
"flickity": "^1.0.0",
"fizzy-ui-utils": "^1.0.0"
"flickity": "^2.0.0",
"fizzy-ui-utils": "^2.0.0"
},
"scripts": {
"test": "echo \"Open test/index.html in browser\" && exit 1"
Expand Down
10 changes: 3 additions & 7 deletions test/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,19 @@

<script src="../bower_components/qunit/qunit/qunit.js"></script>
<!-- dependencies -->
<script src="../bower_components/get-style-property/get-style-property.js"></script>
<script src="../bower_components/get-size/get-size.js"></script>
<script src="../bower_components/matches-selector/matches-selector.js"></script>
<script src="../bower_components/eventEmitter/EventEmitter.js"></script>
<script src="../bower_components/eventie/eventie.js"></script>
<script src="../bower_components/doc-ready/doc-ready.js"></script>
<script src="../bower_components/classie/classie.js"></script>
<script src="../bower_components/desandro-matches-selector/matches-selector.js"></script>
<script src="../bower_components/ev-emitter/ev-emitter.js"></script>
<script src="../bower_components/fizzy-ui-utils/utils.js"></script>
<script src="../bower_components/unipointer/unipointer.js"></script>
<script src="../bower_components/unidragger/unidragger.js"></script>
<script src="../bower_components/tap-listener/tap-listener.js"></script>
<!-- Flickity source -->
<script src="../bower_components/flickity/js/cell.js"></script>
<script src="../bower_components/flickity/js/slide.js"></script>
<script src="../bower_components/flickity/js/animate.js"></script>
<script src="../bower_components/flickity/js/flickity.js"></script>
<script src="../bower_components/flickity/js/drag.js"></script>
<script src="../bower_components/flickity/js/tap-listener.js"></script>
<script src="../bower_components/flickity/js/prev-next-button.js"></script>
<script src="../bower_components/flickity/js/page-dots.js"></script>
<script src="../bower_components/flickity/js/player.js"></script>
Expand Down

0 comments on commit 96c64be

Please sign in to comment.