Select Flickity slides with links
Switch branches/tags
Clone or download

README.md

Flickity hash

Select Flickity slides with links

Features

  • Connect hash links to select Flickity slides. <a href="#cell2">View cell 2</a>
  • Use URLs for slides: https://example.com/#cell2
  • Change page hash to match selected slide.

Install

Add hash.js to your scripts.

Download

CDN

<script src="https://unpkg.com/flickity-hash@1/hash.js"></script>

Package managers

npm: npm install flickity-hash

Bower: bower install flickity-hash

Usage

Enable hash behavior by setting hash: true in Flickity options.

// jQuery
var $carousel = $('.carousel').flickity({
  hash: true,
});
// vanilla JS
var flkty = new Flickity( '.carousel', {
  hash: true,
});
<!-- HTML -->
<div class="carousel" data-flickity='{ "hash": true }'>
  ...
</div>

HTML

Add id attributes to cell elements.

<div class="carousel">
  <div class="carousel-cell" id="carousel-cell1">...</div>
  <div class="carousel-cell" id="carousel-cell2">...</div>
  <div class="carousel-cell" id="carousel-cell3">...</div>
</div>

Hash links will select slides on click.

<a href="#carousel-cell2">View cell 2</a>

Webpack & Browserify

var Flickity = require('flickity-hash');

var flkty = new Flickity( '.carousel', {
  hash: true,
});

RequireJS

requirejs( [ 'path/to/flickity-hash' ], function( Flickity ) {
  var flkty = new Flickity( '.carousel', {
    hash: true,
  });
});

By Metafizzy 🌈🐻