You are here

Home » API reference » ImageLightbox 8

README.txt in ImageLightbox 8

Same filename and directory in other branches
  1. 2.x README.txt
  2. 2.0.x README.txt
ImageLightBox Drupal module

Summary
=========================
This module provides integration with ImageLightBox library.


Installation
=========================
 * Install the module as normal, see link for instructions.
   Link: https://www.drupal.org/documentation/install/modules-themes/modules-8
 * Define image style "imagelightbox" and "imagelightbox small"
 * Go to "Content Type" -> add "Image Field" -> "Manage Display" -> Select the "ImageLightBox" format and configure the image style.

Custom Configuration
=========================
You can override the configuration that comes with the module by copying
the libraries/imagelightbox.config.js to your custom theme. If you put it
in the theme's js folder then you can use the following in your custom
theme's info file.


libraries-override:
  imagelightbox/formatter:
    js:
      libraries/imagelightbox.config.js: js/imagelightbox.config.js
  imagelightbox/imagelightbox:
    js:
      libraries/imagelightbox.config.js: js/imagelightbox.config.js


More information on overriding files can be found here:
https://www.drupal.org/docs/8/theming/adding-stylesheets-css-and-javascript-js-to-a-drupal-8-theme#override-extend

More information about the ImageLightBox configuration file options can
be found here: https://osvaldas.info/image-lightbox-responsive-touch-friendly

Notes
=========================
 * You can use `drush imagelightbox-download` command for easy installation of the
   library.
 * To make it work with Views you should either set "Use field template"
   checkbox or manually add "imagelightbox" class in View field style settings.
 * Download ImageLightBox library from https://github.com/osvaldasvalutis/imageLightbox.js.
 * Unzip the library and place files from dist directory to
   libraries/imagelightbox directory.

File

README.txt
View source 
  1. ImageLightBox Drupal module

  2. 

  3. Summary

  4. =========================

  5. This module provides integration with ImageLightBox library.

  6. 

  7. 

  8. Installation

  9. =========================

  10.  * Install the module as normal, see link for instructions.

  11.    Link: https://www.drupal.org/documentation/install/modules-themes/modules-8

  12.  * Define image style "imagelightbox" and "imagelightbox small"

  13.  * Go to "Content Type" -> add "Image Field" -> "Manage Display" -> Select the "ImageLightBox" format and configure the image style.

  14. 

  15. Custom Configuration

  16. =========================

  17. You can override the configuration that comes with the module by copying

  18. the libraries/imagelightbox.config.js to your custom theme. If you put it

  19. in the theme's js folder then you can use the following in your custom

  20. theme's info file.

  21. 

  22. 

  23. libraries-override:

  24.   imagelightbox/formatter:

  25.     js:

  26.       libraries/imagelightbox.config.js: js/imagelightbox.config.js

  27.   imagelightbox/imagelightbox:

  28.     js:

  29.       libraries/imagelightbox.config.js: js/imagelightbox.config.js

  30. 

  31. 

  32. More information on overriding files can be found here:

  33. https://www.drupal.org/docs/8/theming/adding-stylesheets-css-and-javascript-js-to-a-drupal-8-theme#override-extend

  34. 

  35. More information about the ImageLightBox configuration file options can

  36. be found here: https://osvaldas.info/image-lightbox-responsive-touch-friendly

  37. 

  38. Notes

  39. =========================

  40.  * You can use `drush imagelightbox-download` command for easy installation of the

  41.    library.

  42.  * To make it work with Views you should either set "Use field template"

  43.    checkbox or manually add "imagelightbox" class in View field style settings.

  44.  * Download ImageLightBox library from https://github.com/osvaldasvalutis/imageLightbox.js.

  45.  * Unzip the library and place files from dist directory to

  46.    libraries/imagelightbox directory.