Floatbox v6.0 - Options Reference

floatboxjs.com

Floatbox provides versatility in how it can be configured and used through numerous configuration options and a variety of ways and locations to set those options. This page gives information about the configuration options. See the instructions for information on how these options can be configured globally, in page-specific settings, and targeted to specific items.

Appearance

boxRoundCorners - 'all' | 'top' | 'none'
Enables round corners on all box corners on the outside of the floatbox frame area, on just the top two corners, or 'none' disables all outer round corners (and you get square ones).

boxCornerRadius - pixels (10)
When box round corners are enabled, this defines the outer corner radius in pixels.

contentRoundCorners - 'all' | 'top' | 'none'
Enables round corners on all content corners on the inside of the floatbox frame area, on just the top two corners, or 'none' disables all inner round corners (and you get square ones). The default setting is effectively 'none' because the default contentCornerRadius is 0. Round content corners are available only for browsers that support CSS round corners, and so will not be drawn in IE 8 and earlier.

contentCornerRadius - pixels (0)
When contentRoundCorners are enabled, this defines the inner 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 - pixels (10)
Sets the width in pixels of the shadow effect around the box.

shadowOpacity - 0-1 (0.4)
The opacity or darkness of the shadow effect around the box.

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-1 (0.55)
Opacity or darkness of the full-screen page overlay. 0 is fully transparent, 1 is fully opaque.

controlsOpacity - 0-1 (0.6)
Sets the opacity of the controls that can overlay the floatbox content area: the overlayed prev/next controls, the image resize widget at the top left, and the drag-resizer at the bottom right.

Back to Index

Animations

doAnimations - true | false
Setting doAnimations to false is a short-hand way of setting transitionTime, resizeTime and overlayFadeTime all to 0. When doAnimations is false, startAt, endAt, zoomSource, imageTransition and splitResize become irrelevant.

mobileDoAnimations - true | false
At its default setting of false, mobileDoAnimations turns off animations for mobile devices while letting desktop browser animatations be controlled by doAnimations. Note that if doAnimations is false, mobile animations won't occur regardless of the mobileDoAnimations setting. A mobile browser is defined as one that supports touch events and either has a small-format screen or does not have scrollbars.

overlayFadeTime - seconds (0.4)
Number of seconds for the opacity fade-in and fade-out of the translucent overlay which covers the host page.

resizeTime - seconds (0.5)
Controls the speed of the animated opening and closing resize of the floatbox from and to the thumbnail or click starting position.

fadeTime - seconds (0.4)
This is the time taken to fade in the box contents immediately after starting up the floatbox or before closing it down. If not overridden, tooltips will use 0.2 seconds for fadeIn and context boxes will use 0.

imageTransition - 'crossfade' | 'slide' | 'shift' | 'fade' | 'none'
A variety of animations are available when transitioning between two images in a gallery set. These transitions will be synchronized with any floatbox resizing that needs to occur such that all animations will complete simultaneously. The default transition setting is 'crossfade', which fades out the old image while fading in the new one and resizing the floatbox. An imageTransition setting of 'slide' does not alter opacity but instead will slide the current image out of the floatbox and thereby reveal a stationary next image underneath it. The 'slide' animation works particularly well in conjunction with touch or mouse swipes on the floatbox content to show the next (or previous) image. The 'shift' setting is similar to 'slide' except that instead of being stationary, the new image will slide into the box while the current image slides out, as if the two images were attached at their edges. A setting of 'fade' will cause the images to fade to black (or whatever the current colorTheme is), resize the box if necessary, and then fade the new image in from black. All transition animations can be turned off by setting imageTransition to 'none', in which case the new images will appear instantly without any transition effects.

transitionTime - seconds (0.6)
Controls the speed at which transitions between gallery set images occur.

showStartGif - true | false
Set this to false to hide the spinning gif that's shown during an animated box start or end, or when the fetch of the floatbox content over the network is taking a long time.

startAt - id | null
The default starting point for opening box animations is either at the click or touch location or from a thumbnail if the 'zoom' effect is being used. Set startAt to an id of an element on the page to start the animations from the center of that element. Set startAt to null to make the starting point the center of the screen.

endAt - 'start' | id | null
The endAt option controls the ending point that a floatbox will collapse to when animating out. If zooming from an image down to a thumbnail, the default closing point will be the thumbnail that matches the currently showing image. If not zooming to a thumbnail, the default closing location is at the mouse click or touch that opened the box. If neither of the above, it will go to the center of the screen.
Set endAt to an element's id to set the closing point to the center of that element. This could be useful for example when closing a shopping cart form and wanting to draw attention towards an updated cart link on the page. Set endAt to null to close to the center of the screen, and set it to 'start' to have it close to wherever it started from (which is usually the default behaviour anyway).

zoomSource - img filePath | null
Default behaviour for images is to do 'zoom' animations up from and down to the clicked anchor when opening and closing. The image zoomed is the same image that is being shown. The zoomSource option can be used to assign an alternate image to use for the zoom animation. Set zoomSource to the path of an image file to be used in the animation.
Any content type can have a zoomSource image assigned to it, so you can, for example, open a form by zooming up a screen capture image of that form. To disable the image zooming effect, set zoomSource to null.

zoomBorder - pixels (1)
Sets the border width around the zoomSource image for zooming in and out. Default is 1px.

splitResize - true | false
Default animated resizing of floatbox resizes width, height, top and left simultaneously. Setting splitResize to true yeilds sequenced animation where the X and Y dimensions are resized seperately. When split-resizing, the smallest dimension will be sized first, followed by the other larger dimension. This avoids unaesthetic resize behaviour of initially bloating up in the larger dimension. Note that splitResize does not take effect while 'zooming' an image in or out or while cross-fading between images in a gallery set.

Back to Index

Colors

colorTheme - 'black' | 'white' | 'blue' | 'silver' | 'yellow' | 'red' | 'custom'
When the colorTheme option is not specified, floatbox defaults to black for images, white for HTML content, and blue for multi-media. Assigning a specific colorTheme setting overrides these defaults. To use the 'custom' color theme, you must explicitly load the custom.css file in an include line on your pages immediately below the line for floatbox.css. The custom.css file can be modified to your preferences (hence the name).

boxColor - css color [|css color]
'boxColor' assigns the main background color of the floatbox's frame area using any css color. A gradient effect can also be assigned to the floatbox by setting boxColor to two css colors separated the the '|' character.
If defining a gradient, hex color formats must be used. For example: boxColor:#123456|#edca98
If a gradient is set, boxRoundCorners will be disabled and the floatbox will have square corners. Note that setting boxBackgroundImage can override a boxColor assignment.

overlayColor, innerBorderColor, outerBorderColor - css color
Assign any standard css color to various floatbox components using these options. The best approach when doing extensive appearance customizations is to set the desired options in a class definition in fbClassOptions on a page or in the global classOptions section of options.js. Once this is done, the collection of option settings can be assigned to one or more floatboxed links simply by placing the assigned class name on them.

textColor, strongTextColor - css color
These work the same as the other color options. 'textColor' applies to the 'item x of y' display, index links, and the 'open in a new window' link. 'strongTextColor' applies to captions, info and print links, and the new window link when it's hovered.

boxBackgroundImage - img filePath
The main floatbox frame area can have a background image assigned to it to give texture or other effects. Set boxBackgroundImage to the URL path of the image to be used as the background. Note that when this is set, boxRoundCorners is forced off and the floatbox will be displayed with square corners.

contentBackgroundColor - css color
The default background color of floatbox's content area is white for non-iframe HTML content and transparent for all others. If a different background color is required for some content, the desired color can be assigned by setting the 'contentBackgroundColor' option. Valid values are any color values that can be assigned via css. This setting will have a visible effect ony if the content shown has some transparent areas.

Back to Index

Size

autoFit - true | false
Default behaviour for content that is larger than the viewable screen is to auto-size the floatbox such that it fits within the screen. Set autoFit to false to disable this auto-sizing. Note that auto-sizing never occurs for HTML content where the contentScroll option is set to false.

autoFitSpace - pixels (5)
The minimum space to leave between the floatbox edge and the browser window edge when autoFitting content.

stickyAutoFit - true | false
Setting stickyAutoFit to true will remember the current resize state of an autoFit image that is shown with inFrameResize:false set, and will display the next image in a gallery set at the same resize state as the current image - either full size or scaled down to fit the screen.

measureHTML - true | false
The measureHTML option controls the measuring of HTML content and the automatic setting of a floatbox's height to match that measurement. The default behaviour when measureHTML is not set is to measure only if an explicit height option has not been assigned to the floatbox's opener. Set measureHTML to true or false to override the default behaviour.

enableImageResize - true | false
If enableImageResize 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.

inFrameResize - true | false
An image may be displayed at smaller than its native size when autoFit causes it to scale to fit the viewport. The image can then be resized to its full size using the resizeTool as described below. The default resizing behaviour is for the floatbox frame to remain at its smaller size inside the viewport and for the image to scale up to its full size inside the floatbox frame. It can then be dragged around inside the frame with the mouse or touch gestures. Set inFrameResize to false to disable this behaviour and to cause the entire floatbox, including the frame, to to scale up to full size when requested.

resizeTool - 'cursor' | 'topleft' | 'both'
Sets the tool used when enableImageResize 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.

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. Drag-resizing is always disabled on mobile touch devices because they have a better way of accomplishing the same task.

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 displayed content by setting this option. (draggerLocation is always 'frame' for media content.)

minContentWidth (140), minContentHeight (100) - pixels
minContentWidth and minContentHeight set the lower limits for the dimensions a floatbox can be displayed at. A floatbox will be displayed at at least these dimensions and cannot be drag-resized or auto-sized smaller than these limits. These two options prevent content from becoming too tiny and may result in auto-sized floatboxes that are bigger than the viewport on zoomed small screens. minContentWidth and minContentHeight apply only to images and video and do not apply to HTML content, tooltips or context boxes.

maxContentWidth (0), maxContentHeight (0) - pixels
maxContentWidth and maxContentHeight set the upper size limits for floatbox content dimensions. When set to 0, no limit is in effect and the content will be presented at its native, specified or measured size.
If these options are applied to image content and are smaller than the image's native dimensions, the image will be resize-able up to native dimensions (provided the enableImageResize option has not been set to false).

minBoxWidth (0), minBoxHeight (0) - pixels | 'xx%' | 'max'
minBoxWidth and minBoxHeight can be used to setup a floatbox frame area larger than it would normally be based on the padding option and content size. In a gallery set or slideshow, this could be used to set up a box that fills the screen and remains a constant size while the content area inside the box changes to accommodate the various gallery set members.

Back to Index

Position

boxLeft, boxTop - pixels | 'click' | '[-]xx%'
Default box positioning is for thefloatbox to open centered in the viewable browser screen area (with a little offset toward the top). The 'boxLeft' and 'boxTop' options can be used to change this default box placement. If set to simple integers, those integers will be taken as screen pixel locations at which to place the floatbox. These pixel placement values are relative to the visible browser viewport and not to the underlying document. If set to the string 'click', the floatbox's left and/or top edge will open at the mouse click or touch gesture location. 'boxLeft' and 'boxTop' 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.
Note that regardless of explicit positioning, a floatbox will reposition itself if necessary to appear within the visible viewport area because there is not much point in displaying content off-screen.

boxLeftAdjust, boxTopAdjust - pixels (0)
A floatbox can be dislocated from its natural position on the screen by setting boxLeftAdjust and boxTopAdjust to the pixel amounts of the dislocation. These options apply to tooltips and context boxes as well as standard floatboxes and can be useful for modifying the opening position of those components. As with boxLeft and boxTop, these option will not move content off-screen.

captionPos ('bl'), caption2Pos ('tc'), infoLinkPos ('bl'), printLinkPos ('bl'), newWindowLinkPos ('tr'), itemNumberPos ('bl'), indexPos ('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.

outerClosePos - 'tl' | 'tr'
The round outerClose button can be shown either in the top-left or the top-right corner by setting outerClosePos to the desired value.

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.

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, or on a displayed image (but not html or video content). On mobile touch devices, drag-moving works with a single-finger move gesture. If enableSwipeNav is set to true (its default) touch swipes on image content will not move the floatbox. For non-modal floatboxes (where the modal option is set to false) drag-moving is always enabled regardless of the value set for enableDragMove.

showMoveCursor - true | false
When enableDragMove is true (its default), setting showMoveCursor to true will cause the mouse move cursor to show whenever the mouse is hovered over a part of the floatbox by which it can be dragged around.

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. Set stickyDragMove to true to have floatbox remember its new screen position across item change-overs.

Back to Index

Controls

showClose - true | false
Enables/disables display of the close button in the floatbox border area.

showOuterClose - true | false
Enables/disables display of the round external close button that can be shown at one of the top corners of a floatbox.

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. Print links will not be shown for cross-domain iframe content because cross-domain script blocking will prevent the printing from succeeding.

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:`h4 {color: #123456;} 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.

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..."

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.

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.

controlsType - 'international' | 'english'
controlsType is closely related to the language option. Default when controlsType is not set is for visitors with localized English language browsers and large screens to see the floatbox control graphics that contain English text such as "close" and "next" while non-English or small-screen (e.g., smart-phone) browser users will see graphics-only controls without the English text on them. All browsers can be set to see the graphics-only controls by setting controlsType to 'international', or force English controls by setting this to 'english'.

strongControls - true | false
Setting this to true makes the controls (close button, prev/next, etc) appear always in their on or hovered state. This can be helpful when trying to match against a custom color that is set in the 'boxColor' option or in the css.

showHints - 'once' | true | false
Controls display of system tooltip messages on mouseover of the nav and control buttons. These tooltip messages are intended to be used to inform users about keyboard navigation shortcuts. With the default setting of 'once', each tooltip will deactivate after it has been displayed for sufficient time to be read. A tooltip message will also be deactivated if the user navigates with the associated keyboard shortcut. If enableKeyboardNav is set to false, showHints will be set to false.

outsideClickCloses - true | false
Default behaviour when outsideClickCloses is not set is for modal boxes, tooltips and context boxes to close when something outside the floatbox is clicked or touched. Set this to true to make non-modal boxes close on an outside click, or false to make any box ignore outside clicks.

contentClickCloses - true | false
If set to true, floatbox will exit when the user clicks on the floatbox's displayed content. This option is primarily useful for images and context boxes. By default, a context box will close when the page outside of the floatbox is click or touched, but remains open if interaction occurs within it's content. When set for images that have the navigation overlay active (navType = 'overlay' or 'both'), the click-to-close area is down the center of the image in the space remaining between the left and right navigation areas.

enableKeyboardNav - true | false
Enables or disables the keyboard handler for previous/next, pause/play, resize and close actions.

enableSwipeNav - true | false
Enables or disables use of a touch swipe gesture to navigate to previous or next images in a gallery set. This works especially well with 'imageTransition' set to 'slide'.

Back to Index

Galleries

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 (30)
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 enableImageResize or contentClickCloses are active, you'll want to leave a gap between the nav panels so that there's somewhere on the image that can be clicked.

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 - 'once' | true | false
Controls display of the overlayed navigation 'prev' and 'next' graphics for image content. The default showNavOverlay is not set is to show the overlayed graphics only if the the button-style prev/next controls in the frame area are not present. If set to 'once', these graphics will be displayed only for the first image shown, and are turned off for other images once they have been seen.. 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. Use the 'navType' option to control whether the overlay and button navigation widgets are present or not.

showItemNumber - true | false
Setting showItemNumber to false will disable the display of the 'image/page x of y' text in gallery sets.

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 afterSlideshow option is set to 'loop'.

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.

indexThumbSource - img filePath | 'href'
When showIndexThumbs is true, the default index thumb source is the thumbnail image from a gallery item's associated anchor (link) element on the main page. If there is no such thumbnail, or if an alternate thumbnail is desired, the path to the desired thumbnail image can be specified in the indexThumbSource option. If indexThumbSource is assigned the value 'href', the main image linked to by the host anchor's href attribute will be used as the index thumb. When using the 'href' setting, you'll almost always want to set maxIndexThumbSize as well.

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.

Back to Index

Slideshows

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.

afterSlideshow - 'exit' | 'stop' | '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 afterSlideshow 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.

Back to Index

Tooltips & Context Boxes

source - a content reference
Every tooltip and context box requires a 'source' reference to be defined either in data-fb-tooltip or data-fb-context. This is the reference to the content that will be shown in the tooltip or context box. Commonly, source will point to a hidden div on the page with a syntax like "source:#myDivId", but it can also be a path to any type of floatbox content. e.g., "source:`myContent.html`" to bring in an external page as the tooltip or context box content.

placement - 'bottom' | 'top' | 'left' | 'right' | 'center'
The placement option determines where an enhanced tooltip will open in relation to the hovered element or the mouse location. If attachToHost is set to true, the tooltip placement is relative to the host element, otherwise it is relative to the location of the mouse cursor at the time the tooltip is invoked. If the requested placement would make the tooltip appear partially offscreen, the placement will be moved so that the entire tooltip shows.

attachToHost - true | false
Applies only to tooltips and, if true, will place the tooltip immediately adjacent to the host element 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 can be assigned to an <area> element, but cannot be attached to it.)

moveWithMouse - true | false
Not surprisingly, if this is set to true for a tooltip, it will move with mouse movements. The default of false leaves the tooltip positioned at its starting location regardless of subsequent mouse moves. If attachToHost is set to true, moveWithMouse will be forced to false.

showOnce - true | false
If showOnce is set to true, a tooltip will be displayed only on the first mouse-over of the host element per browser session. A session cookie will be set in the visitor's browser that will prevent the tooltip from re-appearing for that user until a subsequent visit.

delay - milliseconds (80)
Minimum 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 pre version 9 because IE is atrociously bad at fading text and tooltips usually contain text.

contextMouseButton - 'both' | 'left' | 'right'
This option applies only to context boxes and sets which mouse buttons will be used to trigger the display of the context box. Mobile devices will always respond to touch gestures regardless of the contextMouseButton setting. Please see the note in the 'Context boxes' section of the instructions for information about the unreliability of right-clicks in some browsers.

Back to Index

Image/Thumbnail Cyclers

cycleInterval - seconds (5)
The number of seconds between each turnover of the displayed image in a set of cycling images or thumbnails. cycleInterval can be set on individual cycle set members to provide a different delay for different items in the set. See the 'Cycling images and thumbnails' section of the instructions for details.

cycleFadeTime - seconds (1)
Controls the speed of the fade in/out of the images in a set of cycling images or thumbnails.

cycleEnableClick - true | false
If set to true, a cycling image or thumbnail set can be paused and resumed by clicking or touching an image.

cycleShowControls - true | false
When cycleEnableClick is true, a visible play/pause control will be shown on a cycler set unless cycleShowControls has been set to false.

cycleControlsPos - 'tl' | 'tc' | 'tr' | 'bl' | 'bc' | 'br'
Controls the position of a cycler's visible play/pause control when cycleEnableClick and cycleShowControls are active.

cycleStartPaused - true | false
If set to true, a cycler set will begin in the paused state at page load. You'll want to set either cycleEnableClick or cycleResumeOnHover if starting paused.

cyclePauseOnHover - true | false
If set to true, image and thumbnail cyclers will pause and hold the current image while the mouse is hovered over the images. This option is ignored on mouse-less Mobile devices where the cyclers will always cycle.

cycleResumeOnHover - true | false
If set to true, image and thumbnail cyclers will start in a paused state and cycle only while the mouse is hovered over the images. This option is ignored on mouse-less Mobile devices where the cyclers will always cycle.

Back to Index

General

addVideoThumb - width | 'small' | 'medium' | 'large'
Floatbox can fetch video thumbnails from YouTube and Vimeo and can auto-insert these thumbnails into floatboxed anchors that reference videos from these services. The fetched thumbnail will be displayed at the size specified in the addVideoThumb option which can be an explicit pixel width, 120px for 'small', 480px for 'large', and a default of 240px for 'medium' or other non-numeric value (such as true). Setting addVideoThumb on any anchor other than one that references a video from somewhere other than youtube or vimeo will have no effect.

addPlayButton - 'small' | 'medium' | 'large' | false
Any floatboxed anchor that contains a thumbnail can have a translucent play button displayed over top of it by setting the addPlayButton option to the desired button size (small, medium or large). The default action is to add a medium-sized play button to thumbnails added by the addVideoThumb option and to do nothing with other thumbnails. Use the addPlayButton to show a button on standard thumbnails or to change the button size for addVideoThumb thumbnails. Disable the default play button for addVideoThumb thumbnails by setting addPlayButton to false. Note that the 'small', 'medium' and 'large' settings set a size relative to the host thumbnail, and not an absolute pixel size.

fetchVideoInfo - true | false
When videos from YouTube or Vimeo are configured to show in a floatbox, the API services of those providers will be queried to fetch useful information about the video such as the title and default size. (YouTube unfortunately does not provide size info.) If you prefer to not incur the network overhead of these API queries and instead provide explicit size and caption info for your videos, set fetchVideoInfo to false. This can be set per-item in data-fb-options and per-page or globally.

titleAsCaption - true | false | 'a' | 'img'
If a caption is not assigned directly with the caption option, titleAsCaption, when left at its default value of true, will pull a caption in from a title attribute found on the host anchor or on a thumbnail img element within that anchor. A setting of 'a' instructs it to look at title attributes only on the anchor element and a setting of 'img' causes it to look for titles only on thumbnail img elements. To disable the setting of captions from title attributes, set titleAsCaption to false. See the 'caption' and 'caption2' options for details on how to set caption content directly. The titleAsCaption option also applies to fbCycler sets and will cause the cycler captions shown below the images to be pulled from the img elements' title attributes.

altAsCaption - true | false
If altAsCaption is set to true and a caption has not been assigned either through the caption option or as a result of the titleAsCaption option, the caption will be pulled from the alt attribute on a thumbnail image inside the floatboxed anchor. The altAsCaption option also applies to fbCycler sets and will cause the cycler captions shown below the images to be pulled from the img elements' alt attributes.

hideObjects - true | false
If true, objects and embeds (flash, quicktime, silverlight, etc.) on the host page will be hidden while a floatbox is being displayed. 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.

showMagCursor - 'once' | true | false
Changes the mouse cursor to a small magnifying glass when the mouse is hovered over a thumbnail in a floatboxed anchor. If set to 'once', the cursor will change only for the first mouseover on the thumbnail image. Note, that some browsers cannot and will not show the custom cursor regardless of this option's setting. (Older Opera, most Mac browsers except Safari, and some Linux browsers are guilty of this.)

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.

centerOnResize - true | false
When set to true, all open floatboxes will reposition themselves towards the center of the screen when the browser window is resized, and will resize to fit the new window dimensions if autoFit behaviour is enabled.

boxScroll - true | false
If boxScroll is set to false, floatbox will use fixed positioning. Fixed positioning locks the 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, boxScroll is ignored if the current displayed content is larger than the available screen dimensions. Note that some browsers (IE 6 and a bunch of mobile devices) cannot do fixed positioning and boxScroll will have no effect on these platforms.

pageScroll - true | false
When fixed positioning has been assigned by the boxScroll:false option, the scrollbars on the main page can be removed by setting pageScroll to false. This will prevent scrolling of the host page underneath the floatbox when the mouse wheel is used to scroll content inside a fixed-position floatbox.

minFlashVersion - version string ('9.0.115')
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.1 and '10.1.23' are all valid version strings. The default is version 9.0.115 because this is the oldest Flash player that can handle mp4 video content.

autoEndVideo - true | false
A floatbox showing video either with the built-in HTML5 video player or from YouTube or Vimeo will close automatically when the video ends unless autoEndVideo is set to false. (Doesn't always work in IE pre version 9.)

mobileNewWindow - true | false
When set to true, devices with small screens (generally, mobile phones) will open the target content in a new browser window while larger-screened browsers will open the content in a floatbox. This is useful when the content to be displayed is too large to handle cleanly on the small device screens. Default behaviour is to show all cross-domain iframes and direct-loaded pdf content in a new window on small-screen devices. Set mobileNewWindow to false to force content to always show within a floatbox regardless of screen size.

instanceName - string
instanceName is used in conjunction with the API function fb.getInstance to programmatically reference a particular floatbox when more than one is present. If no instanceName is provided, the default instance name will be the filename of the opening content. For example, if you show "/images/my_toys.jpg" in a floatbox, and don't assign a specific instanceName, the box's name will be "my_toys". See the API Reference for fb.getInstance() details.

attachTo - 'click' | elementID
Use 'attachTo' to enhance accessibility of web pages by providing correct sequencing or placement of floatbox content in the HTML DOM hierarchy, 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.

zIndex - number (77777)
Floatbox's default z-indices begin at 77777. If there is other content on a page that is set higher than this (such as maybe a navigation menu), a larger zIndex can be assigned to the floatboxes by setting this option. If you are having trouble with flash objects appearing above the floatbox regardless of zIndex, please see the 'hideObjects' option.

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 that is defined prior to loading floatbox.js. See the "Constraining Floatbox..." section in the instructions for details and examples.

preloadLimit ** - 'x|y' ('5|1')
Floatbox will preload images that are referenced by floatboxed anchors so that those images may be shown immediately when clicked instead of the visitor possibly watching the spinning loader graphic while waiting for the image to be fetched across the network. (Preloading starts shortly after the main page is fully rendered and window.onload fires). preloadLimit sets the number of referenced images that will be preloaded. Two values can be provided, separated by a '|' character, with the left-side value applying to non-touch devices and the right-side value applying to devices that support touch gestures. If just a single number is provided, it will apply to all devices.

language ** - 'en' | ... (see the languages folder)
Floatbox provides international localization through the json files in the languages folder. When the language option is not set, floatbox will detect the visitor's browser language preference and use that language for its system tooltips and other text. You can force a particular language by assigning it here. Doing this will set that language for everyone visiting your site, regardless of where they are coming from.

floatboxClass ** ('floatbox'), cyclerClass ** ('fbCycler'), tooltipClass ** ('fbTooltip'), contextClass ** ('fbContext') - 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 could be changed to 'floater' or any other unused class name.
The floatboxClass option can accept multiple class names by separating them with a '|' character (e.g., floatbox|foo|bar. This can be helpful when working with CMS platforms that allow assignment of only one class to any particular element.

installPath ***, graphicsPath ***, languagesPath *** - folderPath
Use of these 3 options is not recommended, but they are provided for people who want or need to break up the Floatbox package or load it in a non-standard manner. If you are using some sort of deferred javascript loader with floatbox.js, you will probably need to set installPath to allow Floatbox to locate its base folder. The floatbox folder in the downloaded zip file contains the required resources structured in the file and folder hierarchy that the Floatbox code expects. If you really must break apart that folder hierarchy and spread the floatbox files around in different folders, you can tell Floatbox where to find its resource files by setting these options in an fbPageOptions definition that must be placed above the include line for floatbox.js. The specified paths should be absolute and not relative, and they must be terminated with a slash/. Note that if the path relationship between floatbox.css and the graphics folder is altered, floatbox.css will need to be updated with the new relative paths to the background images. Implementation and support of Floatbox will be easier if the floatbox folder structure is left alone, floatbox.js is loaded with a standard script element, and these path options are not used.

** 'preloadLimit', 'language', and the 4 '*Class' names cannot 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.
*** The 3 '*Path' options can be set only in a fbPageOptions object that is defined prior to the floatbox.js file being loaded.

Back to Index

Item-Specific

Options in this section do not have default values defined. While most of these options can be applied globally, per page, per type and per class, they usually make sense only when assigned 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' | 'xx%w'
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 viewport 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. The height option can also accept a format like "60%w" which will set the height to be 80% of the width size. This can be useful for maintaining aspect ration of content while setting the width to be proportional to viewport size. 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:75% height:60%w". 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.

contentScroll - true | false
The contentScroll option controls the display of the scroll bars on the floatbox when showing html content. The default setting of true allows most browsers to show scrollbars if needed and not show them if the content is not larger than the containing box. There are some old browsers that will show scrollbars whether needed or not. Set contentScroll to false to prevent scrollbars in HTML content.

caption, caption2 - string | #hiddenDivId
To display a caption in floatbox, you can use the title attribute of an <a> or <img>element when 'titleAsCaption' is set to true, the alt attribute of an <img> when 'altAsCaption' is set to true, or you can set a 'caption' option in the anchor's data-fb-options (or rev) attribute. Setting it directly with 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 attribute, the text of the caption option must usually 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.

header, footer - string | #hiddenDivId
Display transparent-background content immediately above or below the floatbox with the header and footer options. These can be set in the same manner as captions described above, and can use direct text, encoded html, or a reference to a hidden div (recommended). Although described here in the item-specific section of this options reference, like all options header and footer can be assigned globally, per page, by type, and by class name.

type - 'ajax' | 'video' | 'image' | 'flash'
Floatbox auto-detects content type based on the href file extension, but there are occasions where auto-detection can't work. Two examples are content that is to be loaded via AJAX and iframe-based video embeds. To load AJAX content, you need to set "type:ajax" in the anchor's data-fb-options attribute. For iframe-based video, set "type:video" in the options. (You don't need to set type:video for mp4 files, YouTube, or Vimeo. Floatbox already knows what these are.) You may 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.

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.

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. The 'infoOptions' and 'infoText' options can be combined with 'info' to control the appearance and behaviour. See the instructions and demo for more details.

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 any 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.

useMap - id
An image shown as floatbox content can have an area-map assigned to it by setting the useMap option. The map element should be defined on the base page and have an id attribute set on it. Reference this id as the value of the useMap option. A name attribute on the map element and a reference to that name will not be sufficient to find it; use an id. Note that the areas in the map can themselves have floatboxes, tooltips, and context boxes assigned to them. An area map assigned to a floatboxed image will always scale appropriately with the images as it is resized or auto-fit to the viewport.

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).

className - string
The className option provides a mechanism whereby class-based options can be assigned to infoOptions, options passed to the fb.start API function, and enhanced tooltips. See the instructions to learn about classOptions. The className option provides a mechanism to use these classOptions in contexts other than HTML elements that have matching class attributes set. Set className to one or more classes that you wish to inherit options from.

proportionalResize - true | false
When enableDragResize or one of the autoSize settings is true, the default behaviour is to resize images and multi-media proportionally and allow aproportional resizing of html content. This default behaviour can be overidden per item by setting proportionalResize to true or false.

autoStart - 'once' | true | false
If you place "autoStart:true" in the data-fb-options attribute of a floatbox-enabled <a> element, the associated content (referenced by the href attribute) 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-start 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 document.

autoEnd - seconds (0)
Any floatbox can be set to automatically close after a set period of time. This is particularly useful for enhanced tooltips that you may want to show for 5 seconds or so and then get out of the way.

loadPageOnClose - 'self' | 'back' | url
This controls browser behaviour when a 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. 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 typically needs to be be enclosed in backquotes (`) so as not to break parsing of the option string. The loadPageOnClose option applies only to standard floatboxes and will not fire when a tooltip or context box closes. 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.

order - number
A Floatbox gallery set shows the images in a Floatbox in the order in which they appear within the document. You can force a different order on the gallery set by assigning order numbers to the member items. The set will be sorted in the numerical order of the assigned values.

Back to Index

Event Callbacks

afterFBLoaded, beforeBoxStart, afterBoxStart, beforeItemStart, afterItemStart, beforeItemEnd, afterItemEnd, beforeBoxEnd, afterBoxEnd, afterResize, 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 on these callbacks and much more of Floatbox's programmability.

Back to Index