You are here

Home » API reference » Views Quicksand 7

README.txt in Views Quicksand 7 

INTRODUCTION
--------
Maintainer: Felix Maier
Profile: http://drupal.org/user/264153
Module Project Page: http://drupal.org/sandbox/leschekfm/1286252

Views Quicksand integrates the jQuery Quicksand plugin into Views. Therefore it
provides a views style-plugin, which allows you to alter most settings the
quicksand plugin provides.

IMPORTANT NOTE: This module won't work without a ajax-view and exposed
filters/sort

INSTALLATION
--------
1. Download and extract the module to [yourdrupalroot]/sites/all/modules/
   (final structure will be [yourdrupalroot]/sites/all/modules/views_quicksand/
2. a) Download 'jquery.quicksand.js' from 'http://razorjack.net/quicksand/' and put
   it into [yourdrupalroot]/sites/all/libraries/jquery.quicksand/
   b) Or use 'drush quicksand-plugin'

USAGE
--------
1. Choose the view you want to enable the animation for
2. Determine a html tag and attribute which will identify a view-row as a unique
   item in your view (like the anchor-tag to a node and the href-attribute)
3. Go to the view edit page
4. Change the plugin under Format to "Views Quicksand"
5. Write the previously determined tag and attribute names into the appropriate
   fields on the settings page (use jQuery-selector like syntax)
6. Unless you haven't already: Expose a filter/sort and set your view to use
   ajax
7. Save your view and you should be good to go

TEST MODULE
--------
In the main module a submodule is included to allow you to verify
views_quicksand is working. When enabled the submodule provides a preconfigured
view which should always show a working animation.

JAVASCRIPT HOOKS
--------
There are two custom javascript hooks you can use to attach own enhancement
functions: beforeQuicksandAnimation and afterQuicksandAnimation.
For a demonstration on how to use them have a look at views_quicksand_test.js
BE AWARE that beforeQuicksandAnimation may be fired twice!

Please test the module and provide feedback.
Thanks for using :)

File

README.txt
View source 
  1. INTRODUCTION

  2. --------

  3. Maintainer: Felix Maier

  4. Profile: http://drupal.org/user/264153

  5. Module Project Page: http://drupal.org/sandbox/leschekfm/1286252

  6. 

  7. Views Quicksand integrates the jQuery Quicksand plugin into Views. Therefore it

  8. provides a views style-plugin, which allows you to alter most settings the

  9. quicksand plugin provides.

  10. 

  11. IMPORTANT NOTE: This module won't work without a ajax-view and exposed

  12. filters/sort

  13. 

  14. INSTALLATION

  15. --------

  16. 1. Download and extract the module to [yourdrupalroot]/sites/all/modules/

  17.    (final structure will be [yourdrupalroot]/sites/all/modules/views_quicksand/

  18. 2. a) Download 'jquery.quicksand.js' from 'http://razorjack.net/quicksand/' and put

  19.    it into [yourdrupalroot]/sites/all/libraries/jquery.quicksand/

  20.    b) Or use 'drush quicksand-plugin'

  21. 

  22. USAGE

  23. --------

  24. 1. Choose the view you want to enable the animation for

  25. 2. Determine a html tag and attribute which will identify a view-row as a unique

  26.    item in your view (like the anchor-tag to a node and the href-attribute)

  27. 3. Go to the view edit page

  28. 4. Change the plugin under Format to "Views Quicksand"

  29. 5. Write the previously determined tag and attribute names into the appropriate

  30.    fields on the settings page (use jQuery-selector like syntax)

  31. 6. Unless you haven't already: Expose a filter/sort and set your view to use

  32.    ajax

  33. 7. Save your view and you should be good to go

  34. 

  35. TEST MODULE

  36. --------

  37. In the main module a submodule is included to allow you to verify

  38. views_quicksand is working. When enabled the submodule provides a preconfigured

  39. view which should always show a working animation.

  40. 

  41. JAVASCRIPT HOOKS

  42. --------

  43. There are two custom javascript hooks you can use to attach own enhancement

  44. functions: beforeQuicksandAnimation and afterQuicksandAnimation.

  45. For a demonstration on how to use them have a look at views_quicksand_test.js

  46. BE AWARE that beforeQuicksandAnimation may be fired twice!

  47. 

  48. Please test the module and provide feedback.

  49. Thanks for using :)