README.txt 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. INTRODUCTION
  9. ------------
  10. Colorbox Inline allows you to open content already on the page within a
  11. colorbox. If you would like to load content via AJAX, you can use colorbox_load.
  12. REQUIREMENTS
  13. ------------
  14. Requires the following modules:
  15. * Colorbox (https://drupal.org/project/colorbox)
  16. To create an element which opens the colorbox on click:
  17. Add a the attribute data-colorbox-inline to an element and make it's value a
  18. selector for the content you wish to open.
  19. Eg, <a data-colorbox-inline=".user-login">User Login</a>.
  20. Optional extra configuration you can add:
  21. - `data-width` and `data-height` to the anchor to control the size of the
  22. modal window.
  23. - `data-class` to add a class to the colorbox wrapper.
  24. INSTALLATION
  25. ------------
  26. Install as you would normally install a contributed Drupal module. See:
  27. https://drupal.org/documentation/install/modules-themes/modules-8 for further
  28. information.
  29. CONFIGURATION
  30. -------------
  31. No special requirements
  32. MAINTAINERS
  33. -----------
  34. Current maintainers:
  35. * Sam Becker (Sam152) - https://www.drupal.org/user/1485048
  36. * Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031
  37. * Nick Wilde (NickWilde) - https://www.drupal.org/u/nickwilde