Same filename and directory in other branches
  1. 7.x-1.x README.txt 1 comment
  2. 7.x-2.x README.txt 1 comment
  3. 8.x-1.x README.txt 1 comment
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Installation
 * Configuration
 * Maintainers


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

Colorbox is a light-weight, customizable lightbox plugin for jQuery 1.4.3+.
This module allows for integration of Colorbox into Drupal.
The jQuery library is a part of Drupal since version 5+.

* jQuery - http://jquery.com/
* Colorbox - http://www.jacklmoore.com/colorbox/


FEATURES:
---------

The Colorbox module:

* Works as a Formatter in entities and in views.
* Excellent integration with core image field and image styles and the Insert
  module
* Choose between a default style and a number of other styles that are included.
* Style the Colorbox with a custom Colorbox style in your theme.
* Drush command, drush colorbox-plugin, to download and install the Colorbox
  plugin in "libraries/".

The Colorbox plugin:

* Compatible with: jQuery 1.3.2+ in Firefox, Safari, Chrome, Opera, Internet
  Explorer 7+
* Supports photos, grouping, slideshow, ajax, inline, and iframed content.
* Lightweight: 10KB of JavaScript (less than 5KBs gzipped).
* Appearance is controlled through CSS so it can be restyled.
* Can be extended with callbacks & event-hooks without altering the source
  files.
* Completely unobtrusive, options are set in the JS and require no changes to
  existing HTML.
* Preloads upcoming images in a photo group.
* Currently used on more than 2 million websites.
* Released under the MIT License.


REQUIREMENTS
------------

Just Colorbox plugin in "libraries".

OPTIONAL HTML CAPTIONS
----------------------
Colorbox allows you to place a caption at the bottom of the lightbox.
If you wish to use HTML in your captions, you must install the DOMPurify
library. In your libraries folder, you will need
DOMPurify/dist/purify.min.js.

You can install DOMPurify using drush:
 drush colorbox:dompurify

Or, if you prefer, you can download DOMPurify directly from:
https://github.com/cure53/DOMPurify/releases/latest

From the above link, you can download a zip or tar.gz archive file.
To avoid security issues, please only install the dist directory, and
nothing else from the archive. The drush command above only installs
the dist directory.



The DOMPurify library is optional. Without DOMPurify, the Colorbox module
will convert all captions to plain text.



INSTALLATION
------------

1. Install the module as normal, see link for instructions.
   Link: https://www.drupal.org/documentation/install/modules-themes/modules-8

2. Download and unpack the Colorbox plugin in "libraries" inside root folder.
    Make sure the path to the plugin file becomes:
    "libraries/colorbox/jquery.colorbox-min.js"
   Link: https://github.com/jackmoore/colorbox/archive/master.zip
   Drush users can use the command "drush colorbox-plugin".

3. Change the permission of colorbox plugin inside 'libraries' folder.
    Right click on 'libraries' folder -> properties -> "permissions"
    and change to full permission.

4. Go to "Administer" -> "Extend" and enable the Colorbox module.


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

 * Go to "Configuration" -> "Media" -> "Colorbox" to find all the configuration
   options.

Add a custom Colorbox style to your theme:
----------------------------------------
The easiest way is to start with either the default style or one of the example
styles included in the Colorbox JS library download. Simply copy the entire
style folder to your theme and rename it to something logical like "mycolorbox".
Inside that folder are both a .css and .js file, rename both of those as well to
match your folder name: i.e. "colorbox_mycolorbox.css" and
"colorbox_mycolorbox.js"

Add entries in your theme's .info file for the Colorbox CSS/JS files:

stylesheets[all][] = mycolorbox/colorbox_mycolorbox.css
scripts[] = mycolorbox/colorbox_mycolorbox.js

Go to "Configuration" -> "Media" -> "Colorbox" and select "None" under
"Styles and Options". This will leave the styling of Colorbox up to your theme.
Make any CSS adjustments to your "colorbox_mycolorbox.css" file.


Drush:
------
A Drush command is provides for easy installation of the Colorbox plugin itself.

% drush colorbox-plugin

The command will download the plugin and unpack it in "libraries/".
It is possible to add another path as an option to the command, but not
recommended unless you know what you are doing.


Requires - Drupal 8.8+ or 9
License - GPL (see LICENSE)

File

./README.txt

View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Features

  6.  * Requirements

  7.  * Installation

  8.  * Configuration

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. Colorbox is a light-weight, customizable lightbox plugin for jQuery 1.4.3+.

  16. This module allows for integration of Colorbox into Drupal.

  17. The jQuery library is a part of Drupal since version 5+.

  18. 

  19. * jQuery - http://jquery.com/

  20. * Colorbox - http://www.jacklmoore.com/colorbox/

  21. 

  22. 

  23. FEATURES:

  24. ---------

  25. 

  26. The Colorbox module:

  27. 

  28. * Works as a Formatter in entities and in views.

  29. * Excellent integration with core image field and image styles and the Insert

  30.   module

  31. * Choose between a default style and a number of other styles that are included.

  32. * Style the Colorbox with a custom Colorbox style in your theme.

  33. * Drush command, drush colorbox-plugin, to download and install the Colorbox

  34.   plugin in "libraries/".

  35. 

  36. The Colorbox plugin:

  37. 

  38. * Compatible with: jQuery 1.3.2+ in Firefox, Safari, Chrome, Opera, Internet

  39.   Explorer 7+

  40. * Supports photos, grouping, slideshow, ajax, inline, and iframed content.

  41. * Lightweight: 10KB of JavaScript (less than 5KBs gzipped).

  42. * Appearance is controlled through CSS so it can be restyled.

  43. * Can be extended with callbacks & event-hooks without altering the source

  44.   files.

  45. * Completely unobtrusive, options are set in the JS and require no changes to

  46.   existing HTML.

  47. * Preloads upcoming images in a photo group.

  48. * Currently used on more than 2 million websites.

  49. * Released under the MIT License.

  50. 

  51. 

  52. REQUIREMENTS

  53. ------------

  54. 

  55. Just Colorbox plugin in "libraries".

  56. 

  57. OPTIONAL HTML CAPTIONS

  58. ----------------------

  59. Colorbox allows you to place a caption at the bottom of the lightbox.

  60. If you wish to use HTML in your captions, you must install the DOMPurify

  61. library. In your libraries folder, you will need

  62. DOMPurify/dist/purify.min.js.

  63. 

  64. You can install DOMPurify using drush:

  65.  drush colorbox:dompurify

  66. 

  67. Or, if you prefer, you can download DOMPurify directly from:

  68. https://github.com/cure53/DOMPurify/releases/latest

  69. 

  70. From the above link, you can download a zip or tar.gz archive file.

  71. To avoid security issues, please only install the dist directory, and

  72. nothing else from the archive. The drush command above only installs

  73. the dist directory.

  74. 

  75. 

  76. 

  77. The DOMPurify library is optional. Without DOMPurify, the Colorbox module

  78. will convert all captions to plain text.

  79. 

  80. 

  81. 

  82. INSTALLATION

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

  84. 

  85. 1. Install the module as normal, see link for instructions.

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

  87. 

  88. 2. Download and unpack the Colorbox plugin in "libraries" inside root folder.

  89.     Make sure the path to the plugin file becomes:

  90.     "libraries/colorbox/jquery.colorbox-min.js"

  91.    Link: https://github.com/jackmoore/colorbox/archive/master.zip

  92.    Drush users can use the command "drush colorbox-plugin".

  93. 

  94. 3. Change the permission of colorbox plugin inside 'libraries' folder.

  95.     Right click on 'libraries' folder -> properties -> "permissions"

  96.     and change to full permission.

  97. 

  98. 4. Go to "Administer" -> "Extend" and enable the Colorbox module.

  99. 

  100. 

  101. CONFIGURATION

  102. -------------

  103. 

  104.  * Go to "Configuration" -> "Media" -> "Colorbox" to find all the configuration

  105.    options.

  106. 

  107. Add a custom Colorbox style to your theme:

  108. ----------------------------------------

  109. The easiest way is to start with either the default style or one of the example

  110. styles included in the Colorbox JS library download. Simply copy the entire

  111. style folder to your theme and rename it to something logical like "mycolorbox".

  112. Inside that folder are both a .css and .js file, rename both of those as well to

  113. match your folder name: i.e. "colorbox_mycolorbox.css" and

  114. "colorbox_mycolorbox.js"

  115. 

  116. Add entries in your theme's .info file for the Colorbox CSS/JS files:

  117. 

  118. stylesheets[all][] = mycolorbox/colorbox_mycolorbox.css

  119. scripts[] = mycolorbox/colorbox_mycolorbox.js

  120. 

  121. Go to "Configuration" -> "Media" -> "Colorbox" and select "None" under

  122. "Styles and Options". This will leave the styling of Colorbox up to your theme.

  123. Make any CSS adjustments to your "colorbox_mycolorbox.css" file.

  124. 

  125. 

  126. Drush:

  127. ------

  128. A Drush command is provides for easy installation of the Colorbox plugin itself.

  129. 

  130. % drush colorbox-plugin

  131. 

  132. The command will download the plugin and unpack it in "libraries/".

  133. It is possible to add another path as an option to the command, but not

  134. recommended unless you know what you are doing.

  135. 

  136. 

  137. Requires - Drupal 8.8+ or 9

  138. License - GPL (see LICENSE)