DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

jQuery ColorBox

Created:2010-02-18T17:33:18
Changed by:Raphael Zschorsch
Changed:2012-03-21T17:07:01.290000000
Classification:rzcolorbox
Description:The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:jQuery, ColorBox, Lightbox
Author:Raphael Zschorsch
Email:rafu1987@gmail.com
Info 4:
Language:en

img-1 img-2 jQuery ColorBox - rzcolorbox

jQuery ColorBox

Extension Key: rzcolorbox

Language: en

Keywords: jQuery, ColorBox, Lightbox

Copyright 2009-2012, Raphael Zschorsch, <rafu1987@gmail.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

jQuery ColorBox 1

`Introduction 3 <#__RefHeading__834_396975208>`_

What does it do? 3

Screenshots 3

Thanks to 3

`Users manual 4 <#__RefHeading__842_396975208>`_

ColorBox for Content 4

ColorBox and t3jquery 4

`Configuration 5 <#__RefHeading__848_396975208>`_

Reference ColorBox 5

Reference ColorBox for Content 5

`Known problems 7 <#__RefHeading__856_396975208>`_

`To-Do list 8 <#__RefHeading__858_396975208>`_

`ChangeLog 9 <#__RefHeading__860_396975208>`_

Introduction

What does it do?

  • The extension includes the jQuery ColorBox for images, which is a nice-looking alternative for the allknown Lightbox.
  • It simply adds the colorbox to the image Content Elements. Also a new checkbox in the Text w/ Image or the Image Content Element appears, to activate the ColorBox in a slideshow. There are 5 possible ColorBox Layouts, you can define via TypoScript Extension Templates. Read more about that in the Users Manual Section.
  • Secondly since version 1.0.0, there is the feature to load any content (Content Elements on any page, internal and external pages, html) into the ColorBox. See more about that also in the Users Manual section.
  • Since version 0.2.0, rzcolorbox is also supported for tt_news images. Read more about that in the Configuration section.
  • The extension comes with some out-of-the-box features, but you can also customize it with TS Constants.
  • rzcolorbox is localized in english, german, french and dutch. Contact me, if you would like your language added.
  • For examples just visit http://colorpowered.com/colorbox/
  • ColorBox uses version 1.7.1 of the jQuery Library. rzcolorbox uses version 1.3.19 of the ColorBox Script.

Screenshots

img-3 Thanks to

  • Jack Moore for this amazing jQuery Plugin
  • Kevin Weber for pointing it out to me.
  • Benjamin Niediek and his extension “ perfectlightbox ” which always worked fine, when I used it. rzcolorbox uses a copy of his tt_news Image Marker Function.
  • Sébastien Delcroix for his help on the integration of t3jquery and the french translation
  • Jacco von der Post for the dutch translation
  • Jesper Goos for the danish translation
  • Those of you, who are rating the extension. Thanks guys, keep it up...

Users manual

  • Install the extension from the TYPO3 Extension Repository.
  • Go to your Template and include one of the five Layouts by including the appropriate TS Extension Template. Make sure jQuery ColorBox Base is also selected, as the Constant information are stored here.
  • img-4 Basically, you're done. Go to your desired Content Element and you should see this screen:
  • img-5 If you want, you can define your Images as a Slideshow.

ColorBox for Content

  • If you want to show any Content in the ColorBox, first, you also have to include the TS Extension Template for it:
  • img-6 Then you can go to your page and add the new “ColorBox for Content” Content Element
  • img-7 There you can choose, whether you want to show Content Elements, an external or internal link or plain html in the ColorBox.
  • You have various settings and you can also write a description (RTE). You can also define some of these settings via TypoScript. For more information read the Configuration section.
  • The ColorBox for Content is completely template-based so you can choose a different template for each Content Element you define (Note: You can define more than one ColorBox for Content on one page...). You'll find the default template file in the folder typo3conf/ext/rzcolorbox/res/template/template.html. Just copy this file anywhere you want and modify it, the way you like.

Updating to TYPO3 4.5.x

If you're updating to TYPO3 4.5.x, be sure to change the included static templates to the ones, with the prefix 4.5.

ColorBox and t3jquery

  • You can also use the rzcolorbox Extension with the t3jquery Extension. First of all you need to install the t3jquery extension through the Extension Manager. You might have a look in the manual of the extension.
  • If you want to use the ColorBox with t3jquery, be sure to include the template jQuery ColorBox Base for t3jquery instead of jQuery ColorBox Base, explained above and go to your Template and then to the Constant Editor. Set enableGlobal to 1, which ensures, that you don't include the jQuery Library twice. See more about that in the Configuration section.
  • Then, you can go to the t3jquery Backend Module, analyze the rzcolorbox Extension and create your jQuery Library. If you have problems, just look in the manual of t3jquery, where everything is very well documented.

Configuration

Reference ColorBox

plugin.rzcolorbox properties: TS Constants

enableGlobal

Property

enableGlobal

Data type

boolean

Description

Enable jQuery globally. If you already defined jQuery Plugins in your Site, just set this to “1” and rzcolorbox won't include the jQuery JavaScript.

Default

0

deactivate

Property

deactivate

Data type

boolean

Description

This deactivates the ColorBox and doesn't insert the JS and CSS anymore

Default

0

lllPath

Property

lllPath

Data type

string

Description

If you want to customize the Locallang entries or simply would like to add your language, just copy the file for example to your fileadmin/templates folder and put the whole path to the locallang file here. (fileadmin/templates/colorbox_locallang.xml)

Default

typo3conf/ext/rzcolorbox/locallang.xml

cssPath

Property

cssPath

Data type

string

Description

If you want to customize the CSS File, define the path like: fileadmin/templates/css/styles.css

Default

speed

Property

speed

Data type

string

Description

Sets the speed of the fade and elastic transitions, in milliseconds.

Default

350

slideshowSpeed

Property

slideshowSpeed

Data type

string

Description

Sets the speed of the slideshow, in milliseconds.

Default

2500

transition

Property

transition

Data type

string

Description

Specifies the transition type. Can be set to "elastic", "fade", or "none".

Default

fade

rel

Property

rel

Data type

string

Description

Define the used rel-name. Standard is “rzcolorbox”,

Default

rzcolorbox

opacity

Property

opacity

Data type

string

Description

The overlay opacity level. Range: 0 to 1.

Default

0.85

innerWidth

Property

innerWidth

Data type

string

Description

Set the inner width of the ColorBox (you can use this to resize the images inside the ColorBox). Example: "50%", "500px", or 500.

Default

innerHeight

Property

innerHeight

Data type

string

Description

Set the inner height of the ColorBox (you can also use this to resize the images inside the ColorBox). Example: "50%", "500px", or 500.

Default

initialWidth

Property

initialWidth

Data type

string

Description

Set the initial width, prior to any content being loaded.

Default

initialHeight

Property

initialHeight

Data type

string

Description

Set the initial height, prior to any content being loaded.

Default

width

Property

width

Data type

string

Description

Set a fixed total width. This includes borders and buttons. Example: "100%", "500px", or 500

Default

height

Property

height

Data type

string

Description

Set a fixed total height. This includes borders and buttons. Example: "100%", "500px", or 500

Default

useWidth

Property

useWidth

Data type

boolean

Description

Uses {styles.content.imgtext.maxW} in enabled. This also works for the images shown in the ColorBox.

Default

0

ttnewsSingle

Property

ttnewsSingle

Data type

boolean

Description

This enables the ColorBox for tt_news Images in single view

Default

0

ttnewsList

Property

ttnewsList

Data type

boolean

Description

This enables the ColorBox for tt_news Images in list view

Default

0

ttnewsLatest

Property

ttnewsLatest

Data type

boolean

Description

This enables the ColorBox for tt_news Images in latest view

Default

0

overlayClose

Property

overlayClose

Data type

boolean

Description

If false, disables closing ColorBox by clicking on the background overlay

Default

1

escKey

Property

escKey

Data type

boolean

Description

If false, will disable closing colorbox on esc key press

Default

1

arrowKey

Property

arrowKey

Data type

boolean

Description

If false, will disable the left and right arrow keys from navigating between the items in a group

Default

1

loop

Property

loop

Data type

boolean

Description

If false, will disable the ability to loop back to the beginning of the group when on the last element

Default

1

fixed

Property

fixed

Data type

boolean

Description

If true, ColorBox will be displayed in a fixed position within the visitor's viewport. This is unlike the default absolute positioning relative to the document

Default

0

((generated))
Example
plugin.rzcolorbox {
enableGlobal = 0
cssPath =
speed = 3000
transition = elastic
rel = your-rel
opacity = 0.55
innerWidth = 250px
ttnewsSingle = 1
ttnewsList = 1
ttnewsLatest = 0
}

Reference ColorBox for Content

plugin.tx_rzcolorbox_pi2 properties: TS Setup

templateFile

Property

templateFile

Data type

string

Description

Path to the template for the ColorBox for Content

Default

typo3conf/ext/rzcolorbox/res/template/template.html

colorboxWidth

Property

colorboxWidth

Data type

string

Description

Width of the ColorBox when it opens (Example: "100%", "500px", or 500). Note that the Flexform value overwrites the TypoScript value, so if you globally want to set a width, then leave the Flexform field empty.

Default

100%

colorboxHeight

Property

colorboxHeight

Data type

string

Description

Height of the ColorBox when it opens (Example: "100%", "500px", or 500). Note that the Flexform value overwrites the TypoScript value, so if you globally want to set a height, then leave the Flexform field empty.

Default

100%

linkClass

Property

linkClass

Data type

string

Description

CSS Class for the link. (Important: The Content Element uid is added at the end)

Default

rzcolorbox-content

contentClass

Property

contentClass

Data type

string

Description

CSS Class for the Content. (Important: The Content Element uid is added at the end)

Default

rzce

opacity

Property

opacity

Data type

string

Description

The overlay opacity level. Range: 0 to 1.

Default

0.85

MoveJsFromHeaderToFooter (deprecated)

Property

MoveJsFromHeaderToFooter (deprecated)

Data type

boolean

Description

If set, moves the JS right before the closing body-tag.Since rzcolorbox 1.5.0 this feature is deprecated and the ColorBox JS file will automatically be inserted in the footer, if the option is set in the t3jquery extension configuration.

Default

0

localLangFile

Property

localLangFile

Data type

string

Description

Set path to custom locallang.xml. If you did set a custom locallang file for ColorBox for images, then you have to point this value to the path of the localang file aswell.

Default

typo3conf/ext/rzcolorbox/locallang.xml

((generated))
Example
plugin.tx_rzcolorbox_pi2 {
templateFile = typo3conf/ext/rzcolorbox/res/template/template.html
colorboxWidth = 100%
colorboxHeight = 100%
linkClass = rzcolorbox-content
contentClass = rzce
opacity = 0.7
_LOCAL_LANG.de.link_text = Klick mich jetzt
}

Known problems

  • Sometimes it seems that the created jQuery Library doesn't work fine with the ColorBox with Content. I recreated the file 3-4 times and suddenly it worked for me, so if you encounter this error, try it out or report it as a bug in rzcolorbox forge or contact the author of t3jquery if he has an idea. I reproduced the error twice now.
  • Please report bugs: http://forge.typo3.org/projects/show/extension- rzcolorbox
  • If you updated to rzcolorbox 1.5.0 and are using the extension with tt_news, you have to included the “jQuery ColorBox for tt_news” static TypoScript manually for it to work again, as it is in a separate TypoScript.

To-Do list

ChangeLog

0.0.1

Version

0.0.1

Changes

Initial Upload

0.0.2

Version

0.0.2

Changes

Added lllPath to TS Constants

0.0.3

Version

0.0.3

Changes

Fixed IE Bug for Style 1+4 (added absolutePath), ColorBox is now activated by default and the checkbox is gone

0.1.0

Version

0.1.0

Changes

Minor code changes, changed $() to jQuery() - thanks to Tobias Riesemann for the hint ;)

0.2.0

Version

0.2.0

Changes

now working with tt_news; changed state to beta; Manual update

0.2.1

Version

0.2.1

Changes

script update (v.1.3.5) and manual update

0.2.5

Version

0.2.5

Changes

script update (v.1.3.6), jQuery update (v.1.4), minor changes – now the rzcolorbox groups not all the images on one page

0.2.6

Version

0.2.6

Changes

jQuery 1.4.1, manual update

0.2.7

Version

0.2.7

Changes

Removed JS include only if image_zoom is activated, because there was no include with tt_news anymore. I now added a constant to deactivate the JS and CSS; manual update and now also available as PDF.

1.0.0

Version

1.0.0

Changes

jQuery 1.4.2, new Content Elements feature, manual update, first stable release

1.0.1

Version

1.0.1

Changes

added t3jquery functionality, added slideshowSpeed Constant, removed absolutePath (now rzcolorbox uses config.baseUrl for style 1 and 4), code cleaning, manual update

1.0.2

Version

1.0.2

Changes

Manual update

1.0.3

Version

1.0.3

Changes

Major t3jquery update. Rzcolorbox should now smoothly integrate into t3jquery. Removed enableT3jquery Constant. See manual for more changes.

1.0.5

Version

1.0.5

Changes

Only version changes

1.0.6

Version

1.0.6

Changes

There was a problem with ColorBox for Content and t3jquery, added opacity for ColorBox for Content

1.0.7

Version

1.0.7

Changes

Bugfixing, changed size in FlexForm CE Selectbox, added Locallang marker for linktext, added french translation, manual update

1.0.8

Version

1.0.8

Changes

Link handling in ColorBox for Content didn't work correctly, added useWidth Constant, added jQuery noConflict, TS changes, manual update

1.0.9

Version

1.0.9

Changes

Bugfixing

1.0.10

Version

1.0.10

Changes

Bugfixing

1.1.0

Version

1.1.0

Changes

Added dutch translation (thanks to Jacco von der Post), bugfixing, manual update

1.2.0

Version

1.2.0

Changes

Changed to ColorBox version 1.3.8, added new constants (see manual), fixed issue #8341, manual update

1.2.1

Version

1.2.1

Changes

Changed to ColorBox version 1.3.9, added Flexform input field for Linktitle

1.2.2

Version

1.2.2

Changes

Added support for dam_ttnews (thanks to Georg Leonhardt and Stephan Bauer), TypoScript changes, minor CSS changes

1.2.3

Version

1.2.3

Changes

Added danish translation (Thanks to Jepser Goos), Manual update

1.2.4

Version

1.2.4

Changes

Changed to ColorBox Version 1.3.10 and jQuery Version 1.4.3, partly fixed the bug #9493

1.2.5

Version

1.2.5

Changes

Changed to ColorBox Version 1.3.14

1.2.6

Version

1.2.6

Changes

Bugfix with speed and slideshowSpeed constants

1.2.7

Version

1.2.7

Changes

Changed to ColorBox Version 1.3.15

1.3.0

Version

1.3.0

Changes

New feature to set an image as a link (Flexform), moved JS to <head>-Part

1.3.1

Version

1.3.1

Changes

Bugfixing (Issue 11788) and added feature to move JS in footer (ColorBox for Content)

1.3.2

Version

1.3.2

Changes

Added constants initialWidth and initialHeight

1.3.3

Version

1.3.3

Changes

Bugfixing

1.3.4

Version

1.3.4

Changes

Bugfixing

1.3.5

Version

1.3.5

Changes

Fixed bug #25764 and #26073, added TYPO3 4.5 compatibility

1.4.0

Version

1.4.0

Changes

Security fix, please upgrade: http://typo3.org/teams/security /security-bulletins/typo3-extensions/typo3-ext-sa-2011-012/

1.4.1

Version

1.4.1

Changes

Wrong XCLASS Paths fixed (Thanks to Clemens Riccabona)

1.5.0

Version

1.5.0

Changes

Bugfixing, new TS constants, updated ColorBox and jQuery scripts, seperate tt_news TypoScript

1.5.1

Version

1.5.1

Changes

TypoScript Bugfixing

1.5.2

Version

1.5.2

Changes

Bugfix #29516, Code cleaning

1.5.3

Version

1.5.3

Changes

Added escKey and arrowKey to flexform configuration, removed rel, as it's not html5 valid and not necessary anymore

1.5.4

Version

1.5.4

Changes

Bugfix #35094 (thanks to Thomas Scholze)

img-2 11