Floatbox Configurator (v4.18)
Use this page to generate global or page-specific floatbox options.
Set your preferences the way you want them,
click one of the update buttons to generate a globalOptions or fbPageOptions definition,
and then paste the generated code from the text area as described in the message above the text area.
See the configurator section of the instructions for more details
and the tooltipped help on each form field for information about the available settings.
roundCorners - 'all' | 'top' | 'none'
Enables round corners on all corners, on just the top two, or 'none' disables all round corners (and you get square ones).
cornerRadius - 8 | 12 | 20
When round corners are enabled, this defines the corner radius in pixels.
shadowType - 'drop' | 'hybrid' | 'halo' | 'none'
Set 3D shadow effect.
'drop' sets a 2-sided shadow on the right and bottom.
'hybrid' sets the full shadow on the right and bottom and a fainter half shadow on the left and top.
'halo' sets a full shadow on all 4 sides.
shadowSize - 8 | 12 | 16 | 24
Sets the size in pixels of the drop or halo shadow.
outerBorder - pixels (1)
Width of the border around the outside edge of the box.
If round corners are being used, the outerBorder size will not exceed the corner radius.
innerBorder - pixels (1)
Width of the inside border around the edge of the main content.
padding - pixels (24)
Width of the area between the floatbox content and the outer floatbox edges.
panelPadding - pixels (8)
Gap above and below the contents of the floatbox frame area like the caption and close buttons.
Provides the vertical spacing between the floatbox outer edge, frame content, and main content.
overlayOpacity - 0-100 (55)
Opacity of the full-screen page overlay. 0 is fully transparent, 100 is fully opaque.
color - 'black' | 'white' | 'blue' | 'yellow' | 'red' | 'custom'
When no color option is specified, floatbox defaults to black for images, white for HTML content, and blue for multi-media.
Assigning a specific color setting overrides these defaults.
modal - true | false
When modal is true, floatbox will overlay the whole page with a translucent layer,
the underlying page will be unreachable until the box is closed,
and any secondary floatboxes will be stacked on top of any already-opened boxes.
Setting modal to false removes the translucent page overlay,
allows the underlying page to be accessed while one or more floatboxes are open,
and allows multiple open floatboxes to be re-arranged and restacked.
autoFitImages - true | false
If set to true, large images will be proportionally scaled down to fit the current browser window dimensions before being displayed.
Note that if very large captions are assigned to an image, the caption may be dropped if auto-sizing can not leave enough room for its display.
To guarantee display of large captions, set autoFitImages to false and let the user scroll to see all of the image if necessary.
autoFitHTML - true | false
If set to true, html content will be proportionally resized down to fit within the browser window.
autoFitMedia - true | false
If set to true, direct loaded multi-media content will be proportionally resized down to fit within the browser window.
autoFitSpace - pixels (5)
The minimum space to leave between the floatbox edge and the browser window edge when autoFitting content.
resizeImages - true | false
If resizeImages is set to true, images that have been autoSized to fit the screen, that have been resized with drag-resizing, or are displayed larger than the current screen size can be resized using the resize tool.
resizeTool - 'cursor' | 'topleft' | 'both'
Sets the tool used when resizeImages is true.
The cursor tool enables clicking on the image to resize and displays a magnifying glass to show when resizing is allowed.
The topleft tool is a small semi-transparent button in the top left corner of the image.
captionPos ('bl'), caption2Pos ('tc'), infoLinkPos ('bl'), printLinkPos ('bl'), newWindowLinkPos ('tr'), itemNumberPos ('bl'), indexLinksPos ('br') - 'tl' | 'tc' | 'tr' | 'bl' | 'bc' | 'br'
These options control the positioning of the various widgets that can appear in the floatbox border area.
See the 'layout' section of the instructions for more detail if required.
Values are short-hand for top-left, top-center, top-right, bottom-left, bottom-center and bottom-right.
controlsPos - 'tl' | 'tr' | 'bl' | 'br'
Sets the positioning of the control panel in the floatbox frame.
The control panel is the grouping containing control widgets like the close button, <<prev||next>>, etc.
Values are short-hand for top-left, top-right, bottom-left and bottom-right.
centerNav - true | false
The controls are positioned in one of the box's corners. Usually the < prev || next > controls are right beside the close button.
With this option you can move the nav controls to the center of the top or bottom border area, away from the close button.
boxLeft, boxTop - 'auto' | pixels | '[-]xx%'
By default, the main floatbox frame will be centered in the viewable browser screen area (with a little offset toward the top).
The boxLeft and boxTop options can be used to override this default positioning.
If set to simple integers, those integers will be taken as pixel values to place the floatbox at.
These pixel values are relative to the browser window, like fixed positioning, and not to the underlying document.
These options can also be set to percentage values such as '-50%'.
This will cause the floatbox frame to shift position that portion of the available free space.
For example, a boxLeft setting of '-50%' will move the floatbox half way to the left edge of the browser window.
To use default centering, set boxLeft and boxTop to 'auto'.
enableDragMove - true | false
If true, a floatbox can be dragged around the screen by holding down the left mouse button on the floatbox frame outside of the main content area.
stickyDragMove - true | false
In sets of multiple floatbox items (galleries), if strickyDragMove is false the dragged location is not retained when navigating to the next item.
Floatbox will return to its centered position with each new item.
When stickyDragMove is true, floatbox remembers its new screen position across item change-overs.
enableDragResize - true | false
If true, a small resize widget will be shown in the bottom right corner that people can drag with the mouse to resize the box.
stickyDragResize - true | false
As with stickyDragMove, stickyDragResize instructs floatbox to remember dragged size changes between different items in a gallery.
The stickyDragResize option applies only to proportionally resized content (images and multi-media)
and has no effect on html content.
draggerLocation - 'frame' | 'content'
The widget that is shown when enableDragResize is enabled can be placed either in the bottom right corner of the floatbox frame
or the bottom right corner of the actual content by setting this option.
titleAsCaption - true | false
True by default, this instructs floatbox to display an anchor's title attribute as its caption when no caption value is explicitly set.
Turn this behaviour off by setting titleAsCaption to false.
See the 'caption' and 'caption2' options for details on how to set caption content.
showIE6EndOfLife - true | false
Please see the description of this in the instructions and seriously consider turning this on for all sites.
showItemNumber - true | false
Controls display of the 'image/page x of y' text that appears below the caption.
Note that the text displayed is configured in the imageCount and iframeCount language localization options.
showClose - true | false
Enables/disables display of the close button in the floatbox border area.
showNewWindowIcon - true | false
This works in conjunction with the showNewWindow option.
Set showNewWindowIcon to false to disable display of the small icon beside the 'Open in new window' text.
(showNewWindowIcon is always false on rtl (right-to-left) layout pages.)
closeOnNewWindow - true | false
When set to true, floatbox will end (close) when the newWindow link (described in the options reference and instructions) is clicked.
showPrint - true | false
If showPrint is set to true, a "Print..." link will be shown in the floatbox border area.
This print link invokes a print dialog that will print just the floatbox contents, not the underlying page.
(The "Print..." text is translated/regionalized in the language files.)
See the printCSS option for how to pass css stylings to the print content.
printCSS - css text | css filepath
When showPrint is enabled, you may need to provide some css to format the print content the way you like.
You can provide css settings directly as text. For example, printCSS:`h3 {color: red;} a img {border: 2px solid black;}`.
Or you can set printCSS to the path of an external css file and this will be applied to the print window contents.
E.g., printCSS:myPrint.css.
printText - string
Replaces the default text "Print..." (or the translated equivalent) used for the print link with text of your choice.
cacheAjaxContent - true | false
If you are loading floatbox content via ajax and that content is static, you can speed up performance of subsequent gets by setting cacheAjaxContent to true.
hideObjects - true | false
If true, objects and embeds (flash, quicktime, silverlight, etc.) on the host page will be hidden before floatbox loads.
This is generally a good idea as most objects will appear on top of the floatbox display if not hidden.
Flash objects using the default wmode of 'window' have this problem (feature?).
If you set your flash objects to have a wmode of 'opaque' or 'transparent' they will not appear over top of the other content
and you won't need to enable hideObjects.
hideJava - true | false
Just like hideObjects but for Java applets.
centerOnResize - true | false
When set to true, floatbox will reposition itself toward the center of the screen when the browser window is resized.
disableScroll - true | false
If true, floatbox will use fixed positioning.
Fixed positioning locks floatbox in a fixed screen location that will not move in response to scrollbar actions.
Because scrolling is not available when fixed positioning is used, it is not set if the current displayed content is larger than the available screen dimensions.
Note that fixed positioning is always set for iframe and quicktime content in firefox 2 (if it fits the screen) to workaround some display issues with that browser,
and it is never set for IE6 because IE6 can't do it.
randomOrder - true | false
Gallery sets of multiple items normally are ordered by their position in the html document.
By setting randomOrder to true, you can shuffle your gallery sets to a random order.
This can be a nice touch for some slideshows.
floatboxClass ('floatbox'), cycleClass ('fbCycler'), tooltipClass ('fbTooltip') - className
The class names that are used to activate floatbox elements can be changed in order to avoid conflicts with other html and css.
For example, if the 'floatbox' class is already used for other purposes, the floatboxClass option can be changed to 'fbBox' or some other unused class name.
preloadAll - true | false
If true, floatbox will aggressively preload all images that are referenced by floatboxed anchors.
This makes floatbox quite responsive because images are available and can be displayed as soon as the site visitor clicks on or navigates to one.
If you wish to lighten your server and network load, you can set preloadAll to false.
When preloadAll is false, the first image found on a page will be preloaded and gallery sets will preload the next image in sequence when an image from the set is shown.
Without preloadAll set, a site visitor may get the spinning loader graphic while waiting for an image to download.
language - 'auto' | 'en' | ... (see the languages folder)
Floatbox provides international localization through the json files in the languages folder.
When the language option is set to 'auto', floatbox will detect the visitor's browser language preference and use that language for its tooltips and other text.
You can force a particular language by seeting it here.
Doing this will set that language for everyone visiting your site, regardless of where they are coming from.
graphicsType - 'auto' | 'international' | 'english'
graphicsType is closely related to the language option.
When set to 'auto', visitors with localized English language browsers will see the floatbox control graphics that contain English text such as "close" and "next"
while non-English browser users will see graphics-only controls without the English text on them.
You can force all browsers to see the graphics-only controls by setting graphicsType to 'international', or force English controls with the 'english' option.
* 'preloadAll' and 'language' can not be set as type, class or item options. They can be set only in the globalOptions section of options.js or in a page-specific fbPageOptions javascript object.
doAnimations - true | false
Setting doAnimations to false is a short-hand way of setting resizeDuration, imageFadeDuration and overlayFadeDuration all to 0.
resizeDuration - 0-10 (3.5)
Controls the speed at which animated resizing occurs.
0 = no resize animation, 1 is fast, 10 is slooow.
These are unit-less numbers, and don't equate to a fixed time period.
Larger size changes will take longer than smaller size changes.
imageFadeDuration - 0-10 (3)
Controls the speed of the opacity fade-in for images as they come into the display.
0 = no image fade-in, 1 is fast, 10 is slooow. These too are unit-less numbers.
overlayFadeDuration - 0-10 (4)
Controls the speed of the opacity fade-in and fade-out for the translucent overlay which covers the host page.
0 = no overlay fading in or out, 1 is fast, 10 is slooow. Unit-less.
startAtClick - true | false
If true (and resizeDuration is not 0) floatbox will expand out from the clicked anchor and shrink back to that anchor when closed.
If false, floatbox will start and end from the center of the screen.
zoomImageStart - true | false
If true (and resizeDuration is not 0) images will expand out from the clicked thumbnail on start and collapse back to the thumbnail on exit.
liveImageResize - true | false
If true (and resizeDuration is not 0) images will remain displayed while they are being resized.
If false they will be hidden during a resize and the "loading" gif displayed in their place.
splitResize - 'no' | 'auto' | 'wh' | 'hw'
Default animated resizing of floatbox resizes width, height, top and left simultaneously.
The settings other than 'no' give sequenced animation where the X and Y dimensions are resized seperately.
The two options 'wh' and 'hw' force either width or height to always go first.
The better splitResize option is probably 'auto'. This will always do the smallest dimension first.
Using a splitResize of auto prevents unaesthetic resize behaviour of initially bloating up in the larger dimension.
cycleInterval - seconds (5)
The number of seconds between each turnover of the displayed image in a set of cycling images or thumbnails.
cycleFadeDuration - 0-10 (4.5)
Controls the speed of the fade in/out of the images in a set of cycling images or thumbnails.
1 is really fast, 10 is slow. Unit-less.
cyclePauseOnHover - true | false
If set to true, image and thumbnail cyclers will pause and hold the current image while the mouse is hovered over it.
navType - 'overlay' | 'button' | 'both' | 'none'
Sets the type of navigation controls to display.
'overlay' is the "Prev/Next" image overlay.'
'button' gives "<<prev||next>>" in the controls area of the floatbox frame.
Overlay navigation is not available for html and multi-media content, just for images.
navOverlayWidth - 0-50 (35)
Sets the width in percentage of each of the left and right transparent overlay nav panels that provide navigation through mouse clicks on the displayed image.
If set to 50, each panel will be half the image width and so will meet without a gap in the middle.
40 leaves a 20% gap between panels, etc.
If image resizing is enabled and you're using the cursor tool, you'll want to leave a gap between the nav panels so that there's somewhere to click for resizing.
navOverlayPos - 0-100 (30)
When the mouse is active over an image with navType 'overlay' or 'both' set, small prev/next graphics are displayed.
This setting is the percentage height from the image top that these graphics will appear.
0 puts them right at the top, and 100 places them at the bottom of the image.
showNavOverlay - 'always' | 'once' | 'never'
Controls display of the overlayed navigation prev and next graphics for image content.
If set to 'once', these graphics will be displayed only for the first image shown, after which they are turned off.
The idea behind this is that once people are told what the mouse does over the image, they don't need to keep seeing the prev/next graphics continuously.
When the overlay nav graphics are turned off overlay nav still works, it is just not displayed.
When both the overlay and button nav types are enabled, the button nav controls will highlight as the mouse moves over active image areas.
showHints - 'always' | 'once' | 'never'
Controls display or mouseover tooltip messages for the nav and control buttons.
These tooltips are intended to be used to inform users about keyboard navigation shortcuts.
If set to 'once', each tooltip will deactivate after it has been displayed for sufficient time to be read.
They will also be deactivated if the user navigates with the associated keyboard shortcut.
If enableKeyboardNav is set to false, the tooltip nav messages will not be shown.
enableWrap - true | false
Enables gallery wrapping so that selecting 'next' on the last item wraps to the first, and selecting 'prev' on the first item wraps to the last.
Because gallery viewing can start anywhere in a series of images, it is probably a good idea to leave this set to true in most circumstances.
But if you are displaying something like a series of instructions that always starts with item #1 you may want to turn wrapping off.
The enableWrap option affects only mouse and keyboard navigation.
Even when enableWrap is set to false, a slideshow will wrap if started with an item other than #1 or if the slideshow endTask is set to 'loop'.
enableKeyboardNav - true | false
Enables or disables the keyboard handler for prev, next, pause/play, resize and close actions.
outsideClickCloses - true | false
If set to true, floatbox will exit when the user clicks on the page overlay outside of the floatbox display.
imageClickCloses - true | false
If set to true, floatbox will exit when the user clicks on the displayed image.
When the navigation overlay is active (navType = overlay or both), the click-to-close space is the space left between the left and right navigation areas.
numIndexLinks - number (0)
Index links are a grouping of numbered links that will jump floatbox to the selected item of a gallery set when clicked.
They look like this: "1 2 3 4 5 ..."
If set to 0, no index links will be shown.
If set to -1 or to a number greater than the number of items in a gallery set, all index links will be shown - one for each item in the gallery.
If set to a positive integer less than the number of gallery items, only that number of links will be shown.
For example, if maxIndexLinks = 9 for a 99 item gallery you get something like
"1 ... 12 13 14 15 16 17 18 ... 99"
showIndexThumbs - true | false
Controls the display of popup thumbnails in the indexLinks group.
If true, thumbnail popups will be displayed when an index link is hovered.
pipIndexThumbs - true | false
The default of true causes the popup thumbnails on index links to appear over-top of the content image in the corner closest to the index thumbs.
If set to false, the thumbnails will appear immediately above or below the clickable index link numbers.
maxIndexThumbSize - pixels (0)
The popup thumbnails used in the index links are taken from the img elements inside the associated anchor on your base page.
These thumbnails may be larger than you would like to see for the index links popup thumbnails.
You can limit the popup size by setting maxIndexThumbSize to the pixel size you want the thumbnail's largest dimension restricted to.
If maxIndexThumbSize is 0, the index link thumbnails will be shown at their native size.
doSlideshow - true | false
If set to true, images in a gallery set will be launched as a slideshow.
slideInterval - seconds (4.5)
This is the number of seconds to display each image in a slideshow before moving on to the next one.
Per-item intervals can be assigned to the item options of individual slideshow members.
endTask - 'stop' | 'exit' | 'loop'
Describes what to do when all images in a slideshow have been seen.
Note that if a slideshow was started on other than the 1st image, it will wrap around until all images have been seen before acting on the endTask directive.
showPlayPause - true | false
Turns display of the slideshow play & pause controls on or off.
startPaused - true | false
If true, a slideshow will start in a paused state. If false, the slideshow will auto-play on start.
pauseOnPrev - true | false
If set to true, the slideshow will pause when a 'prev' contol is clicked or when the corresponding keyboard action (left arrow) is fired.
pauseOnNext - true | false
If set to true, the slideshow will pause when a 'next' contol is clicked or when the corresponding keyboard action (right arrow) is fired.
pauseOnResize - true | false
If set to true, the slideshow will pause when the current content is resized through use of the resize tool.
attachToHost - true | false
If true, the tooltip will be placed immediately adjacent to the host element (either above or below)
and will not move with the mouse.
This allows the mouse to be active inside the open tooltip and thereby allows clickable links to be placed in the tooltip content.
A tooltip cannot be attached to an <area> element.
moveWithMouse - true | false
Not surprisingly, if this is set to true the tooltip will move with mouse movements.
The default of false leaves the tooltip positioned at its starting location regardless of subsequent mouse moves.
placeAbove - true | false
If true, the tooltip will appear above the host element.
The default placement is below the element or mouse cursor depending on whether attachToHost is set or not.
If the requested placement would make the tooltip appear partially offscreen,
the placement will be moved so that the entire tooltip shows.
timeout - seconds (0)
Number of seconds to show a tooltip before terminating it.
The default of zero sets no timeout and the tooltip will be shown as long as the mouse remains hovered.
delay - milliseconds (80)
Delay in milliseconds between the element mouseover event and the display of the tooltip.
mouseSpeed - pixels per second (120)
The mouse must be moving at a speed less than mouseSpeed in order for the tooltip to appear.
fadeDuration - 0-10 (3)
This is a unitless setting (not seconds) that controls the duration of the opacity fade in and out of the tooltip when it starts and ends.
0 is no fade and 10 is very slow.
Note fadeDuration is always 0 for Internet Explorer (all versions) because IE is atrociously bad at fading text and tooltips usually contain text.
defaultCursor - true | false
In most browsers, the mouse cursor will change to a text selection tool whenever it is hovered over text.
Setting defaultCursor to true forces the default arrow cursor to be in effect for all of the tooltip-enabled host element.
Options in this section do not have a default value defined. While all the options can be applied globally, per page, per type and per class, most of these options make sense only when applied on a per item basis.
group - string
Anchors that have the same group option set on them will form a gallery set that can be navigated with the prev/next buttons or shown as a slideshow.
width, height - pixels | 'xx%' | 'max'
Width and height set in the options control floatbox content size.
Plain integers are the size in pixels.
If a percentage is given, like "85%", floatbox will be sized to that portion of the available browser display area.
One or both of width and height can be set to 'max' to size the content to the current browser display width and/or height.
A typical options tag containing dimension settings for multi-media content might look like this: data-fb-options="width:360 height:240" or data-fb-options="width:55% height:max".
For compatability with pages already configured for other lightbox clones, you can also use the css-like syntax of data-fb-options="width:360px; height:240px;".
Width and height options can apply to images, but they're intended for html and multimedia content.
You are better off letting images auto-size as that will maintain the correct proportions.
Note that for html content of type ajax, inline, or direct, you're best off setting only a width either in the options or in the html itself,
and letting floatbox measure and auto-set the height of the content.
This allows floatbox to get correct sizing across different browsers that have small variations in the way they layout pages.
scrolling - 'auto' | 'no'
The scrolling option the display of the scroll bars for the floatbox content.
If no scrolling value is present, image and media content defaults to 'scrolling:no' and html content (iframe page, ajax, hidden div, inline) defaults to 'scrolling:auto'.
Except, if height is not set on an html item, causing that item to be auto-sized, scrolling will default to 'no'.
The 'auto' setting in theory will show scrollbars only if the the content is bigger than the floatbox area,
but in practice some browsers always show scrollbars when set to 'auto'.
caption, caption2 - string | #hiddenDivId
To display a caption in floatbox, you can use the title attribute of an <a> element when titleAsCaption is set to true,
or you can set a 'caption' option in the anchor's data-fb-options (or rev) attribute.
Setting it directly in the caption option allows you to have a different or no tooltip for the anchor mouse-overs, lets you use html markup in your caption, and is the recommended approach.
When assigned in a data-fb-options setting, the text of the caption option must be surrounded by backquote characters (`) so as not to break parsing of the option string.
Example: data-fb-options="caption:`This is my kool kaption`"
A second caption can be assigned to a floatbox item by setting 'caption2' in the same manner as 'caption'.
The easiest way to include html content in a caption is to reference a hidden div that contains the desired content, like this:
data-fb-options="caption:#myCaptionDiv"
You can also place encoded html directly in the caption string.
See the "Captions" section of the instructions for details.
type - 'ajax' | 'image' | 'inline' | 'iframe' | 'flash' | 'quicktime' | 'wmp' | 'silverlight' | 'pdf'
Floatbox auto-detects content type based on the href file extension, but there are occasions where auto-detection can't work.
One example is content that is to be loaded via AJAX. To load AJAX content, you need to set "type:ajax" in the anchor's data-fb-options attribute.
You may also need to set the type option for images that do not have a standard image file extension but are delivered by mime type from, say, a php page.
autoTypes - 'type1|type2|...'
The autoTypes option is unique in that it can only go on a containing element that is used to propogate floatbox activation to its child elements.
(See "Activating elements" in the instructions).
The autoTypes option limits what content types will be activated within the containing div.
It is a string of valid type names separated by the '|' character, and is useful only for content types that can be indentified by their href paths and file extensions.
Valid type names are 'image', 'iframe', 'flash', 'quicktime', 'wmp', 'silverlight', 'pdf', and 'media' for all 5 multi-media types.
(Note that youtube and other media service links are recognized as flash content.)
For example, to activate all images, flash and pdf links on a page:
<body class="floatbox" data-fb-options="autoTypes:image|flash|pdf">
showThis - true | false
An anchor with "showThis:false" in its data-fb-options (or rev) attribute will not be added to a gallery or slideshow collection.
However, other options set on the anchor will take effect.
The showThis option is there primarily to enable a clickable link to display a gallery as a slideshow.
Such a link would have at least the following in its options attribute: data-fb-options="showThis:false doSlideshow:true group:xyz".
The 'group' option is necessary to identify which gallery set this link is associated with.
sameBox - true | false
The default behaviour when floatboxed content is invoked while an existing floatbox is already being displayed is to display the new content in a new secondary floatbox over top of the existing one.
Use sameBox:true to cause the new content to replace the existing content within the existing floatbox and not open up a second box.
altContent - string
Provide alternate content for floatboxed images and iframes by assigning text to the 'altContent' option.
This accessibility enhancement is described in greater detail, with examples, in the 'Accessible content' section of the floatbox instructions.
attachTo - 'click' | elementID
Use 'attachTo' to enhance accessibility of web pages by providing correct sequencing or placement of floatbox content,
or to attach the floatbox to an ASP.NET form.
When set to 'click', the floatbox will attach in the document tree just after the element that was clicked to launch the floatbox.
To place the floatbox inside a particular element, such as a form, specify the id for that element.
More information is available in the 'Attach to a specific document element' section of the instructions.
info - source reference
Assigning a url or other source type to the info option will make floatbox display an "Info..." link that will load the referenced source in a new secondary floatbox.
See the instructions and demo for more details.
infoOptions - option string
Used in conjunction with the 'info' option, this allows assigning configuration options to the secondary info floatbox using the standard options attribute syntax.
Wrap the infoOptions in backquotes for correct parsing and see the instructions and demo for more details.
infoText - string
Replaces the default text "Info..." (or the translated equivalent) used for the info link with text of your choice.
For example, if you're displaying EXIF information through the info option, you may want to set infoText to "EXIF..."
tooltip - source reference
To show an enhanced tooltip over top of standard floatbox content, set the tooltip option to the the source of the tooltip content.
This will most often be a hidden div reference like '#someHiddenDivId', but can be an valid floatbox source reference.
tooltipOptions - option string
When the tooltip option is set on a floatboxed anchor, the tooltipOptions setting can be used to assign options to the enhanced tooltip itself.
This setting takes a standard floatbox option string of name:value pairs, but the string must be surrounded by back-quotes for correct parsing.
backgroundColor - css color string
The standard background color of floatbox's content area is set in floatbox.css as white.
If a different background color is required for some content, the desired color can be assigned by setting the 'backgroundColor' option.
Valid values are any color values that can be assigned via css.
showNewWindow - true | false
If showNewWindow is set to true, a "Open in a new window" link will be shown in the floatbox border area.
Clicking this link will open a new browser window or tab with the floatbox content loaded as an ordinary page.
("Open in a new window" is translated/regionalized in the language files.)
Use the showNewWindowIcon and closeOnNewWindow options in conjunction with showNewWindow.
source - source reference
A "source:`...`" option, usually set in the data-fb-options or rev attribute, will override the href defined on a floatbox-enabled anchor.
Floatbox will use the source option value, while browsers with javascript disabled will load the anchor's standard href value.
This can be used to provide alternate content for javascript-disabled clients.
'source' can be any content type (url, ajax, inline div, or direct html).
There's an example titled 'Alternate content for javascript-disabled browsers' in the instructions.
sizeRatio - 'width/height'
The sizeRatio option allows you to show an item at the maximum size that will fit in the browser window
while also retaining proportional width and height ratios. For example: "sizeRatio:4/3"
proportionalResize - true | false
When enableDragResize is true, the default behaviour is to resize images and multi-media proportionally and allow aproportional resizing of html content.
You can override this default behaviour per item by setting proportionalResize to true or false in an anchor's rev or data-fb-options attribute.
autoStart - 'once' | true | false
If you place "autoStart:true" in the data-fb-options attribute of a floatbox enabled <a> element,
the associated image or iframe will be automatically started on host page load without the user clicking on any content.
An autoStart setting of 'once' will cause that item to auto-display in floatbox only on the first load of the host page per browser session.
Note, you can also set autoStart in the page's query string as described in the instructions.
loadPageOnClose - 'self' | 'back' | url
This controls browser behaviour when floatbox closes.
If set to the string 'self', the host page will be refreshed on exit.
If set to 'back', the previous page in the browser's history list will be loaded.
(Please see the 'Auto-start and exit tasks' section of the instructions for details of a Firefox bug which can interfere with 'loagPageOnClose:back'.)
If loadPageOnClose is set to a string other than 'self' or 'back', that string is assumed to be a valid url and the browser will be instructed to load that page.
When loadPageOnClose is set to a url it must be enclosed in backquotes (`) so as not to break parsing of the option string.
Note that when using the API call 'fb.end()' to close a box, the loadPageOnClose value can be passed directly to that function as a parameter.
E.g., fb.end('/somePage.html')
See the API reference for details.
minFlashVersion - version string
When direct-loading flash, you can require that a minimum version of flash is installed on the visitor's browser.
If the required version is not present, floatbox will show a language-localized message to that effect and present a link for getting the latest flash version.
The version string must include the major version number and may include the minor and revision numbers.
For example, '10', '10.0' and '10.0.22' are all valid version strings.
framed - true | false
Use the framed option to attach floatbox to an iframe or frameset child window.
This will constrain floatbox to the frame area only instead of having it overlay the entire top document.
For frameset pages, floatbox.js must be included in a child frame document, not in the frameset document itself,
and the 'framed' option must be set.
The 'framed' option can be set either as a querystring on the floatbox.js include line, or set to true in fbPageOptions.
See the "Constraining Floatbox..." section in the instructions for details and examples.
afterFBLoaded, beforeBoxStart, afterBoxStart, beforeItemStart, afterItemStart, beforeItemEnd, afterItemEnd, beforeBoxEnd, afterBoxEnd, beforePrint, afterPrint - function | eval string
These are callback functions that can be set in the same manner as other floatbox options.
See the API reference for details.