You are here

Home » API reference » Page Load Progress 8

README.txt in Page Load Progress 8

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

* Introduction
* Configuration
* Caveats
* Maintainers
* Credits

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

Page Load Progress is a module that sets a screen lock showing a throbber when
the user submits a form that triggers a time consuming task. It unequivocally
indicates a task is being executed, and, as a result, improves the overall user
experience. By forbidding users from clicking around while waiting, it also
prevents task execution failures, e.g. when working with web services.

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

To configure the behavior of this module go to
admin/config/user-interface/page-load-progress.

CAVEATS
-------

Even though you can leverage a Configuration Management override or a Twig
template to change the default behavior, it is strongly recommended you trigger
the throbber only on form submits and internal links as these are the only
supported use cases. Be warned!

If you must, assign the behavior to external "<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 use specific classes when
assigning the behavior (example "a.not-modal").

MAINTAINERS
-----------

* anavarre (https://www.drupal.org/u/anavarre)
* Dom. (https://www.drupal.org/u/dom)

CREDITS
-------

This module was originally created and maintained for Drupal 7 by Mariano
(https://www.drupal.org/u/mariano)

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4. * Introduction

  5. * Configuration

  6. * Caveats

  7. * Maintainers

  8. * Credits

  9. 

  10. INTRODUCTION

  11. ------------

  12. 

  13. Page Load Progress is a module that sets a screen lock showing a throbber when

  14. the user submits a form that triggers a time consuming task. It unequivocally

  15. indicates a task is being executed, and, as a result, improves the overall user

  16. experience. By forbidding users from clicking around while waiting, it also

  17. prevents task execution failures, e.g. when working with web services.

  18. 

  19. CONFIGURATION

  20. ------------

  21. 

  22. To configure the behavior of this module go to

  23. admin/config/user-interface/page-load-progress.

  24. 

  25. CAVEATS

  26. -------

  27. 

  28. Even though you can leverage a Configuration Management override or a Twig

  29. template to change the default behavior, it is strongly recommended you trigger

  30. the throbber only on form submits and internal links as these are the only

  31. supported use cases. Be warned!

  32. 

  33. If you must, assign the behavior to external "" elements carefully. ""

  34. elements can be opened in a new browser tab or window, which would leave the

  35. original window locked waiting for reload. Also, "" elements are sometimes

  36. used with modals, so make sure that you identify what classes trigger modal

  37. windows and you use :not() to avoid them, or use specific classes when

  38. assigning the behavior (example "a.not-modal").

  39. 

  40. MAINTAINERS

  41. -----------

  42. 

  43. * anavarre (https://www.drupal.org/u/anavarre)

  44. * Dom. (https://www.drupal.org/u/dom)

  45. 

  46. CREDITS

  47. -------

  48. 

  49. This module was originally created and maintained for Drupal 7 by Mariano

  50. (https://www.drupal.org/u/mariano)