You are here

Home » API reference » Parallax Toolkit 7.3

readme.txt in Parallax Toolkit 7.3

Same filename and directory in other branches
  1. 7.2 parallax_block/readme.txt
CONTENTS OF THIS FILE
---------------------

  * Introduction
  * Requirements
  * Installation
  * Configuration
  * Troubleshooting
  * FAQ
  * Future Features
  * Maintainers



 INTRODUCTION
---------------
The Parallax Block module enables the user to select none, Same, or
Opposite directions (vertically and/or horizontally) when creating a block.
Selecting Same or Opposite places a data-attribute which is ready by
the attached javascript file, and then targeted for calculations causing
parallax effect based on 'same' or ' opposite' value.



 REQUIREMENTS
---------------
  * Use of this module requires Blocks to be enabled.
  * Use of this module requires jQuery 1.7 or later.



 INSTALLATION
---------------
  * Install as usual
  * See: https://drupal.org/documentation/install/modules-themes/modules-7


 CONFIGURATION
---------------
  * Immediately after installation, please make sure that your site is using
    jQuery 1.7 or later. To automate this, try using the jQuery Update module.
  * This module requires no configuration in its initial release. Additional
    releases may change this.
  * The user requires permission to administer blocks.



TROUBLESHOOTING
---------------
  * If the option when creating new blocks does not appear, make sure the module
    is enabled. Then, check to see if another module is modifying the block
    creation page.
  * If there are no data-attributes being applied to the blocks when a value has
    been saved, please try updating jQuery with jQuery Updater. This module
    requires jQuery 1.7 or later. After that, please submit a bug report.


      FAQ
---------------
  * Will this module work on mobile devices?
  - No, the javascript is actually disabled on devices with mobile browsers.
    The reason for this is that for touchscreen devices, DOM manipulation is
    frozen during the scroll event, resulting in a stuttery effect.

  * Should I use this all over my site?
  - Probably not. Parallax is a very cool effect, but works best when used in
    moderation. That said, using it in a ton of places on the same page could
    cause some performance issues, especially on slower, older computers.

  * How is this different from the parallax module at
    https://drupal.org/project/parallax?
  - The Parallax module was recently published and has already been deprecated
    at the time of this writing. My personal testing has found several errors
    caused by the other module.

    The other module only allows you to create blocks with the explicit purpose
    of having a parallax effect behind hand-made markup. Parallax Block allows
    you to modify ANY block on your site (including blocks generated by Views)
    to have a parallax effect.


  MAINTAINERS
---------------
  Current maintainers:
  * Matthew Coker (mattcoker) - https://drupal.org/user/2765587

File

parallax_block/readme.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.   * Introduction

  5.   * Requirements

  6.   * Installation

  7.   * Configuration

  8.   * Troubleshooting

  9.   * FAQ

  10.   * Future Features

  11.   * Maintainers

  12. 

  13. 

  14. 

  15.  INTRODUCTION

  16. ---------------

  17. The Parallax Block module enables the user to select none, Same, or

  18. Opposite directions (vertically and/or horizontally) when creating a block.

  19. Selecting Same or Opposite places a data-attribute which is ready by

  20. the attached javascript file, and then targeted for calculations causing

  21. parallax effect based on 'same' or ' opposite' value.

  22. 

  23. 

  24. 

  25.  REQUIREMENTS

  26. ---------------

  27.   * Use of this module requires Blocks to be enabled.

  28.   * Use of this module requires jQuery 1.7 or later.

  29. 

  30. 

  31. 

  32.  INSTALLATION

  33. ---------------

  34.   * Install as usual

  35.   * See: https://drupal.org/documentation/install/modules-themes/modules-7

  36. 

  37. 

  38.  CONFIGURATION

  39. ---------------

  40.   * Immediately after installation, please make sure that your site is using

  41.     jQuery 1.7 or later. To automate this, try using the jQuery Update module.

  42.   * This module requires no configuration in its initial release. Additional

  43.     releases may change this.

  44.   * The user requires permission to administer blocks.

  45. 

  46. 

  47. 

  48. TROUBLESHOOTING

  49. ---------------

  50.   * If the option when creating new blocks does not appear, make sure the module

  51.     is enabled. Then, check to see if another module is modifying the block

  52.     creation page.

  53.   * If there are no data-attributes being applied to the blocks when a value has

  54.     been saved, please try updating jQuery with jQuery Updater. This module

  55.     requires jQuery 1.7 or later. After that, please submit a bug report.

  56. 

  57. 

  58.       FAQ

  59. ---------------

  60.   * Will this module work on mobile devices?

  61.   - No, the javascript is actually disabled on devices with mobile browsers.

  62.     The reason for this is that for touchscreen devices, DOM manipulation is

  63.     frozen during the scroll event, resulting in a stuttery effect.

  64. 

  65.   * Should I use this all over my site?

  66.   - Probably not. Parallax is a very cool effect, but works best when used in

  67.     moderation. That said, using it in a ton of places on the same page could

  68.     cause some performance issues, especially on slower, older computers.

  69. 

  70.   * How is this different from the parallax module at

  71.     https://drupal.org/project/parallax?

  72.   - The Parallax module was recently published and has already been deprecated

  73.     at the time of this writing. My personal testing has found several errors

  74.     caused by the other module.

  75. 

  76.     The other module only allows you to create blocks with the explicit purpose

  77.     of having a parallax effect behind hand-made markup. Parallax Block allows

  78.     you to modify ANY block on your site (including blocks generated by Views)

  79.     to have a parallax effect.

  80. 

  81. 

  82.   MAINTAINERS

  83. ---------------

  84.   Current maintainers:

  85.   * Matthew Coker (mattcoker) - https://drupal.org/user/2765587