jquery-quicksand

Quicksand
=========

jQuery plugin for reordering and filtering items with a nice shuffling
animation like the one in this
video.

Project site: .

Demos & docs
------------

Please visit the project site for live
demos & documentation.

Usage
-----

The following example would filter items in \#content with shuffling
animation, leaving only CMYK colors.

``javascript
$("#content").quicksand($("#data > li"),
{
// all the parameters have sensible defaults
// and in most cases can be optional
duration: 1000,
easing: "swing",
attribute: "data-id",
}
);
`

The markup could look like this:

`html


1. Red


2. Green


3. Blue


4. Black


5. White


6. Yellow


7. Cyan


8. Magenta

1. Cyan


2. Magenta


3. Yellow


4. Black


`

Please note that you need to set additional attribute (you can specify
which one in options hash, by default it's data-id) so that the plugin
can identify same elements within source and destination collections.

No additional CSS is required for the plugin to work. However, you
should avoid styling the subject container using id selectors ----
please use class instead.

- the subject (#content) is a container visible for the user
- the first parameter ( $("#data > li") ) should contain a
collection which will replace contents of the subject
- duration - specifies duration (in milliseconds) of the animation
effect, default: 750
- easing - animation easing effect, default: 'swing'
- attribute - attribute containing unique value able to identify
same item within source and destination collection, default:
'data-id'
- adjustHeight - 'dynamic' to animate height of the container
(when the target collection is larger or smaller than source
collection), 'call' to automatically set height before or after
the animation, false to keep container height constant; default:
'call'
- adjustWidth - Adjusts the width of container to fit all the items,
'call' for automatically adjusting before or after the animation
(determined automatically), 'dynamic' for width adjustment animation,
'auto' to set the value to 'auto', false for not doing absolutely
anything about it (useful on responsive pages).
- useScaling - use CSS3 scaling effect, default: false
- enhancement - function that performs custom visual enhancements
(e.g. font replacements) on newly created items, default: function() {}.
Since version 1.5 of this plugin, this shouldn't be required in most cases
as elements created by jquery.quicksand are deep-cloned, which preserves
their enhancements and attached events.

You can specify a callback function as an optional last argument.

Dependencies
------------

- jQuery 1.6.1+. jQuery 2 and jQuery 3 is fully supported
- Optional: jQuery Easing (http://gsgd.co.uk/sandbox/jquery/easing/)
for additional easing options
- Optional: jquery.transform2d.js from
jquery.transform.js for
CSS3 scaling effect.

Browser compatibility
---------------------

Tested under:

- Safari 4
- Chrome 4
- Firefox 3.5
- Opera 10.15
- Internet Explorer 7
- Internet Explorer 8

No Internet Explorer 6 support is planned. Ever. The plugin, however,
does not break your web application on IE6, it just skips the animation
and replaces the collection immediately.

I recommend using the plugin with HTML5 markup but any other option is
fine.

Custom attribute function
-------------------------

If you don't like HTML5 data-\* attributes, you can specify a function
instead.

`javascript
$("#content").quicksand($("#data > li"),
{
// all the parameters have sensible defaults
// and in most cases can be optional
duration: 1000,
easing: "swing",
attribute: "data-id",
attribute: function(v) {
// different src of img means: different object
return $(v).find('img').attr('src');
}
}
);
`

Integration with enhancement plugins
------------------------------------

(This option shouldn't be needed if you use Quicksand v1.5 or higher)

Quicksand works fine with other plugins. Please note that:

- when your items have functional enhancements (e.g. tooltips),
remember to use callback to apply them on newly cloned objects:

`javascript
$("#content").quicksand($("#data > li"),
{
duration: 1000,
}, function() { // callback function
$('#content a').tooltip();
}
);
`

- when your items are visually enhanced (e.g. font replacement), use
enhancement function to refresh/apply during the animation

`javascript
$("#content").quicksand($("#data > li"),
{
duration: 1000,
enhancement: function() {
Cufon.refresh('#content span');
}
}
);
``

Licensing
---------

Copyright © 2010 Jacek Galanciak.

Dual licensed under MIT and GPL version 2 license.

In simple language: you don't get any warranty or promise of future maintenance
of this library, but you can modify the code or use this library, without any limitations, in
commercial products, including commercial website templates.