You are here

Home » API reference » Page Load Progress 7

README.txt in Page Load Progress 7

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
---------------------


 * Introduction
 * Configuration
 * Caveats


INTRODUCTION
------------


Current maintainer: Mariano Asselborn <marianoasselborn@gmail.com>

This module will allow you to set a screen lock showing a spinner when the user
clicks on an element that triggers a time consuming task.

The module will work amazingly in cases where, for example, the user submits a
form that takes a long time to post and stays in the current page avoiding the
submitter the chance to poke around the page while waiting.


CONFIGURATION
------------


To configure the behavior of this module go to
admin/config/user-interface/page_load_progress. The last field, "Elements that
will trigger the throbber", takes HTML elements, classes or ids, separated by
commas, and assigns the behavior when they are clicked.


CAVEATS
-------


Even though the behavior assignment is configurable, I recommend its
usage only for form submits. If you must, assign the behavior to "A" elements
carefully. "A" elements can be opened in a new browser tab or window, which
would leave the original window locked waiting for reload. Also, "A" elements
are sometimes used with modals, so make sure that you identify what classes
trigger modal windows and you use :not() to avoid them, or you use specific
classes when assigning the behavior (example "a.not-modal").

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5. 

  6.  * Introduction

  7.  * Configuration

  8.  * Caveats

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. 

  15. Current maintainer: Mariano Asselborn 

  16. 

  17. This module will allow you to set a screen lock showing a spinner when the user

  18. clicks on an element that triggers a time consuming task.

  19. 

  20. The module will work amazingly in cases where, for example, the user submits a

  21. form that takes a long time to post and stays in the current page avoiding the

  22. submitter the chance to poke around the page while waiting.

  23. 

  24. 

  25. CONFIGURATION

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

  27. 

  28. 

  29. To configure the behavior of this module go to

  30. admin/config/user-interface/page_load_progress. The last field, "Elements that

  31. will trigger the throbber", takes HTML elements, classes or ids, separated by

  32. commas, and assigns the behavior when they are clicked.

  33. 

  34. 

  35. CAVEATS

  36. -------

  37. 

  38. 

  39. Even though the behavior assignment is configurable, I recommend its

  40. usage only for form submits. If you must, assign the behavior to "A" elements

  41. carefully. "A" elements can be opened in a new browser tab or window, which

  42. would leave the original window locked waiting for reload. Also, "A" elements

  43. are sometimes used with modals, so make sure that you identify what classes

  44. trigger modal windows and you use :not() to avoid them, or you use specific

  45. classes when assigning the behavior (example "a.not-modal").