marionette-dialogregion-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c4d878f05db87092bf8f91484c72ace47d71df4
+  data.tar.gz: 3182e8df30bc44d160d15d8f1cc719fb8b3221df
+SHA512:
+  metadata.gz: 6e0d3a4542ef2d4348d4f40be256d41d720afbda4f1de357928bf042cbab6d64a7e01eca8b4dce82ef7d12067a7d97ece0a33b363c69a871796cb54cfd6f3df2
+  data.tar.gz: 7825d6fbc2f478fc14c1720fbde992039c0cebf6bd99b30fcbab888802de6fab653642631d8e4d9d1d4b2b2e8d4aa3eee2839887f42b553137b469480cce06a8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marionette-dialogregion-rails.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,68 @@
+marionette-dialogregion-rails
+=============================
+
+Custom Marionette region setup for dialogs/lightboxes, vendored for Rails projects using the asset pipeline. 
+
+Largely based on Brian Mann's [Building Dialogs with Custom Regions](http://www.backbonerails.com/screencasts/building-dialogs-with-custom-regions) screencast, with a few extra options to make the dialogs un-closeable and to work around issues opening consecutive dialogs with Colorbox.
+
+Dependencies
+------------
+
+Depends on Backbone, Marionette, and jQuery, since there are so many different solutions available to vendoring these assets, we don't provide one for you. The lightbox solution used, [colorbox](http://www.jacklmoore.com/colorbox/), _is_ included as we depend on some unreleased bug fixes. This may change in the future.
+
+Setup
+-----
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem marionette-dialogregion-rails
+```
+
+And run `bundle install`.
+
+Require the JavaScripts in your `application.js.coffee`:
+
+```coffeescript
+#= require marionette-dialogregion-rails
+```
+
+Then, in your Marionette app, you can declare a region to be a dialog by extending `Marionette.Region.Dialog` and providing a selector for the element you wish to use for your dialogs:
+
+```coffeescript
+App.addRegions
+  dialogRegion: Marionette.Region.Dialog.extend el: "#dialog"
+```
+
+Now, when you show a view in that region, it will be displayed in a Colorbox lightbox:
+
+```coffeescript
+App.dialogRegion.show view
+```
+
+Options
+-------
+
+Currently, there is only one option available, `closable`. It defaults to `true`, but if you make it `false`, the dialog will not be closable by clicking on the background overlay or pressing the Escape key:
+
+```coffeescript
+view = new MyView fake: true
+App.dialogRegion.show view
+```
+
+Copyright and Licence
+---------------------
+
+ Copyright 2014 Avalanche Technology Group Pty Ltd
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/marionette-dialogregion-rails.rb

@@ -0,0 +1,10 @@
+require 'rails'
+
+module Marionette
+  module DialogRegion
+    module Rails
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/lib/marionette-dialogregion-rails/version.rb

@@ -0,0 +1,7 @@
+module Marionette
+  module DialogRegion
+    module Rails
+      VERSION = "0.0.1"
+    end
+  end
+end

data/marionette-dialogregion-rails.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marionette-dialogregion-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "marionette-dialogregion-rails"
+  spec.version       = Marionette::DialogRegion::Rails::VERSION
+  spec.authors       = ["Louis Simoneau"]
+  spec.email         = ["simoneau.louis@gmail.com"]
+  spec.description   = %q{Colorbox dialog region for Marionette}
+  spec.summary       = %q{Custom Marionette region setup for dialogs/lightboxes, vendored for Rails projects using the asset pipeline.}
+  spec.homepage      = "https://github.com/avalancheau/marionette-dialogregion-rails"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 3.1"
+  spec.add_dependency "coffee-rails", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/vendor/assets/javascripts/dialog-region.js.coffee

@@ -0,0 +1,29 @@
+do (Backbone, Marionette, $) ->
+
+  class Marionette.Region.Dialog extends Marionette.Region
+
+    onShow: (view) ->
+      options = _.defaults(
+        view.options,
+        closable: true
+      )
+
+      $.colorbox
+        href: @$el
+        inline: true
+        closeButton: false
+        transition: 'none'
+        fadeOut: 100
+        overlayClose: options.closable
+        escKey: options.closable
+        onCleanup: =>
+          @oldView = @currentView
+        onClosed: =>
+          if @oldView == @currentView
+            @oldView.close()
+
+      @listenTo view, 'close', ->
+        $.colorbox.remove()
+
+      @listenTo view, 'region:show', ->
+        $.colorbox.resize()

data/vendor/assets/javascripts/jquery-colorbox.js

@@ -0,0 +1,1090 @@
+/*!
+  Colorbox v1.5.9 - 2014-04-25
+  jQuery lightbox and modal window plugin
+  (c) 2014 Jack Moore - http://www.jacklmoore.com/colorbox
+  license: http://www.opensource.org/licenses/mit-license.php
+*/
+(function ($, document, window) {
+  var
+  // Default settings object.
+  // See http://jacklmoore.com/colorbox for details.
+  defaults = {
+    // data sources
+    html: false,
+    photo: false,
+    iframe: false,
+    inline: false,
+
+    // behavior and appearance
+    transition: "elastic",
+    speed: 300,
+    fadeOut: 300,
+    width: false,
+    initialWidth: "600",
+    innerWidth: false,
+    maxWidth: false,
+    height: false,
+    initialHeight: "450",
+    innerHeight: false,
+    maxHeight: false,
+    scalePhotos: true,
+    scrolling: true,
+    opacity: 0.9,
+    preloading: true,
+    className: false,
+    overlayClose: true,
+    escKey: true,
+    arrowKey: true,
+    top: false,
+    bottom: false,
+    left: false,
+    right: false,
+    fixed: false,
+    data: undefined,
+    closeButton: true,
+    fastIframe: true,
+    open: false,
+    reposition: true,
+    loop: true,
+    slideshow: false,
+    slideshowAuto: true,
+    slideshowSpeed: 2500,
+    slideshowStart: "start slideshow",
+    slideshowStop: "stop slideshow",
+    photoRegex: /\.(gif|png|jp(e|g|eg)|bmp|ico|webp|jxr|svg)((#|\?).*)?$/i,
+
+    // alternate image paths for high-res displays
+    retinaImage: false,
+    retinaUrl: false,
+    retinaSuffix: '@2x.$1',
+
+    // internationalization
+    current: "image {current} of {total}",
+    previous: "previous",
+    next: "next",
+    close: "close",
+    xhrError: "This content failed to load.",
+    imgError: "This image failed to load.",
+
+    // accessbility
+    returnFocus: true,
+    trapFocus: true,
+
+    // callbacks
+    onOpen: false,
+    onLoad: false,
+    onComplete: false,
+    onCleanup: false,
+    onClosed: false,
+
+    rel: function() {
+      return this.rel;
+    },
+    href: function() {
+      // using this.href would give the absolute url, when the href may have been inteded as a selector (e.g. '#container')
+      return $(this).attr('href');
+    },
+    title: function() {
+      return this.title;
+    }
+  },
+
+
+  // Abstracting the HTML and event identifiers for easy rebranding
+  colorbox = 'colorbox',
+  prefix = 'cbox',
+  boxElement = prefix + 'Element',
+
+  // Events
+  event_open = prefix + '_open',
+  event_load = prefix + '_load',
+  event_complete = prefix + '_complete',
+  event_cleanup = prefix + '_cleanup',
+  event_closed = prefix + '_closed',
+  event_purge = prefix + '_purge',
+
+  // Cached jQuery Object Variables
+  $overlay,
+  $box,
+  $wrap,
+  $content,
+  $topBorder,
+  $leftBorder,
+  $rightBorder,
+  $bottomBorder,
+  $related,
+  $window,
+  $loaded,
+  $loadingBay,
+  $loadingOverlay,
+  $title,
+  $current,
+  $slideshow,
+  $next,
+  $prev,
+  $close,
+  $groupControls,
+  $events = $('<a/>'), // $({}) would be prefered, but there is an issue with jQuery 1.4.2
+
+  // Variables for cached values or use across multiple functions
+  settings,
+  interfaceHeight,
+  interfaceWidth,
+  loadedHeight,
+  loadedWidth,
+  index,
+  photo,
+  open,
+  active,
+  closing,
+  loadingTimer,
+  publicMethod,
+  div = "div",
+  requests = 0,
+  previousCSS = {},
+  init;
+
+  // ****************
+  // HELPER FUNCTIONS
+  // ****************
+
+  // Convenience function for creating new jQuery objects
+  function $tag(tag, id, css) {
+    var element = document.createElement(tag);
+
+    if (id) {
+      element.id = prefix + id;
+    }
+
+    if (css) {
+      element.style.cssText = css;
+    }
+
+    return $(element);
+  }
+
+  // Get the window height using innerHeight when available to avoid an issue with iOS
+  // http://bugs.jquery.com/ticket/6724
+  function winheight() {
+    return window.innerHeight ? window.innerHeight : $(window).height();
+  }
+
+  function Settings(element, options) {
+    if (options !== Object(options)) {
+      options = {};
+    }
+
+    this.cache = {};
+    this.el = element;
+
+    this.value = function(key) {
+      var dataAttr;
+
+      if (this.cache[key] === undefined) {
+        dataAttr = $(this.el).attr('data-cbox-'+key);
+
+        if (dataAttr !== undefined) {
+          this.cache[key] = dataAttr;
+        } else if (options[key] !== undefined) {
+          this.cache[key] = options[key];
+        } else if (defaults[key] !== undefined) {
+          this.cache[key] = defaults[key];
+        }
+      }
+
+      return this.cache[key];
+    };
+
+    this.get = function(key) {
+      var value = this.value(key);
+      return $.isFunction(value) ? value.call(this.el, this) : value;
+    };
+  }
+
+  // Determine the next and previous members in a group.
+  function getIndex(increment) {
+    var
+    max = $related.length,
+    newIndex = (index + increment) % max;
+
+    return (newIndex < 0) ? max + newIndex : newIndex;
+  }
+
+  // Convert '%' and 'px' values to integers
+  function setSize(size, dimension) {
+    return Math.round((/%/.test(size) ? ((dimension === 'x' ? $window.width() : winheight()) / 100) : 1) * parseInt(size, 10));
+  }
+
+  // Checks an href to see if it is a photo.
+  // There is a force photo option (photo: true) for hrefs that cannot be matched by the regex.
+  function isImage(settings, url) {
+    return settings.get('photo') || settings.get('photoRegex').test(url);
+  }
+
+  function retinaUrl(settings, url) {
+    return settings.get('retinaUrl') && window.devicePixelRatio > 1 ? url.replace(settings.get('photoRegex'), settings.get('retinaSuffix')) : url;
+  }
+
+  function trapFocus(e) {
+    if ('contains' in $box[0] && !$box[0].contains(e.target) && e.target !== $overlay[0]) {
+      e.stopPropagation();
+      $box.focus();
+    }
+  }
+
+  function setClass(str) {
+    if (setClass.str !== str) {
+      $box.add($overlay).removeClass(setClass.str).addClass(str);
+      setClass.str = str;
+    }
+  }
+
+  function getRelated(rel) {
+    index = 0;
+
+    if (rel && rel !== false && rel !== 'nofollow') {
+      $related = $('.' + boxElement).filter(function () {
+        var options = $.data(this, colorbox);
+        var settings = new Settings(this, options);
+        return (settings.get('rel') === rel);
+      });
+      index = $related.index(settings.el);
+
+      // Check direct calls to Colorbox.
+      if (index === -1) {
+        $related = $related.add(settings.el);
+        index = $related.length - 1;
+      }
+    } else {
+      $related = $(settings.el);
+    }
+  }
+
+  function trigger(event) {
+    // for external use
+    $(document).trigger(event);
+    // for internal use
+    $events.triggerHandler(event);
+  }
+
+  var slideshow = (function(){
+    var active,
+      className = prefix + "Slideshow_",
+      click = "click." + prefix,
+      timeOut;
+
+    function clear () {
+      clearTimeout(timeOut);
+    }
+
+    function set() {
+      if (settings.get('loop') || $related[index + 1]) {
+        clear();
+        timeOut = setTimeout(publicMethod.next, settings.get('slideshowSpeed'));
+      }
+    }
+
+    function start() {
+      $slideshow
+        .html(settings.get('slideshowStop'))
+        .unbind(click)
+        .one(click, stop);
+
+      $events
+        .bind(event_complete, set)
+        .bind(event_load, clear);
+
+      $box.removeClass(className + "off").addClass(className + "on");
+    }
+
+    function stop() {
+      clear();
+
+      $events
+        .unbind(event_complete, set)
+        .unbind(event_load, clear);
+
+      $slideshow
+        .html(settings.get('slideshowStart'))
+        .unbind(click)
+        .one(click, function () {
+          publicMethod.next();
+          start();
+        });
+
+      $box.removeClass(className + "on").addClass(className + "off");
+    }
+
+    function reset() {
+      active = false;
+      $slideshow.hide();
+      clear();
+      $events
+        .unbind(event_complete, set)
+        .unbind(event_load, clear);
+      $box.removeClass(className + "off " + className + "on");
+    }
+
+    return function(){
+      if (active) {
+        if (!settings.get('slideshow')) {
+          $events.unbind(event_cleanup, reset);
+          reset();
+        }
+      } else {
+        if (settings.get('slideshow') && $related[1]) {
+          active = true;
+          $events.one(event_cleanup, reset);
+          if (settings.get('slideshowAuto')) {
+            start();
+          } else {
+            stop();
+          }
+          $slideshow.show();
+        }
+      }
+    };
+
+  }());
+
+
+  function launch(element) {
+    var options;
+
+    if (!closing) {
+
+      options = $(element).data('colorbox');
+
+      settings = new Settings(element, options);
+
+      getRelated(settings.get('rel'));
+
+      if (!open) {
+        open = active = true; // Prevents the page-change action from queuing up if the visitor holds down the left or right keys.
+
+        setClass(settings.get('className'));
+
+        // Show colorbox so the sizes can be calculated in older versions of jQuery
+        $box.css({visibility:'hidden', display:'block', opacity:''});
+
+        $loaded = $tag(div, 'LoadedContent', 'width:0; height:0; overflow:hidden; visibility:hidden');
+        $content.css({width:'', height:''}).append($loaded);
+
+        // Cache values needed for size calculations
+        interfaceHeight = $topBorder.height() + $bottomBorder.height() + $content.outerHeight(true) - $content.height();
+        interfaceWidth = $leftBorder.width() + $rightBorder.width() + $content.outerWidth(true) - $content.width();
+        loadedHeight = $loaded.outerHeight(true);
+        loadedWidth = $loaded.outerWidth(true);
+
+        // Opens inital empty Colorbox prior to content being loaded.
+        var initialWidth = setSize(settings.get('initialWidth'), 'x');
+        var initialHeight = setSize(settings.get('initialHeight'), 'y');
+        var maxWidth = settings.get('maxWidth');
+        var maxHeight = settings.get('maxHeight');
+
+        settings.w = (maxWidth !== false ? Math.min(initialWidth, setSize(maxWidth, 'x')) : initialWidth) - loadedWidth - interfaceWidth;
+        settings.h = (maxHeight !== false ? Math.min(initialHeight, setSize(maxHeight, 'y')) : initialHeight) - loadedHeight - interfaceHeight;
+
+        $loaded.css({width:'', height:settings.h});
+        publicMethod.position();
+
+        trigger(event_open);
+        settings.get('onOpen');
+
+        $groupControls.add($title).hide();
+
+        $box.focus();
+
+        if (settings.get('trapFocus')) {
+          // Confine focus to the modal
+          // Uses event capturing that is not supported in IE8-
+          if (document.addEventListener) {
+
+            document.addEventListener('focus', trapFocus, true);
+
+            $events.one(event_closed, function () {
+              document.removeEventListener('focus', trapFocus, true);
+            });
+          }
+        }
+
+        // Return focus on closing
+        if (settings.get('returnFocus')) {
+          $events.one(event_closed, function () {
+            $(settings.el).focus();
+          });
+        }
+      }
+
+      $overlay.css({
+        opacity: parseFloat(settings.get('opacity')) || '',
+        cursor: settings.get('overlayClose') ? 'pointer' : '',
+        visibility: 'visible'
+      }).show();
+
+      if (settings.get('closeButton')) {
+        $close.html(settings.get('close')).appendTo($content);
+      } else {
+        $close.appendTo('<div/>'); // replace with .detach() when dropping jQuery < 1.4
+      }
+
+      load();
+    }
+  }
+
+  // Colorbox's markup needs to be added to the DOM prior to being called
+  // so that the browser will go ahead and load the CSS background images.
+  function appendHTML() {
+    if (!$box && document.body) {
+      init = false;
+      $window = $(window);
+      $box = $tag(div).attr({
+        id: colorbox,
+        'class': $.support.opacity === false ? prefix + 'IE' : '', // class for optional IE8 & lower targeted CSS.
+        role: 'dialog',
+        tabindex: '-1'
+      }).hide();
+      $overlay = $tag(div, "Overlay").hide();
+      $loadingOverlay = $([$tag(div, "LoadingOverlay")[0],$tag(div, "LoadingGraphic")[0]]);
+      $wrap = $tag(div, "Wrapper");
+      $content = $tag(div, "Content").append(
+        $title = $tag(div, "Title"),
+        $current = $tag(div, "Current"),
+        $prev = $('<button type="button"/>').attr({id:prefix+'Previous'}),
+        $next = $('<button type="button"/>').attr({id:prefix+'Next'}),
+        $slideshow = $tag('button', "Slideshow"),
+        $loadingOverlay
+      );
+
+      $close = $('<button type="button"/>').attr({id:prefix+'Close'});
+
+      $wrap.append( // The 3x3 Grid that makes up Colorbox
+        $tag(div).append(
+          $tag(div, "TopLeft"),
+          $topBorder = $tag(div, "TopCenter"),
+          $tag(div, "TopRight")
+        ),
+        $tag(div, false, 'clear:left').append(
+          $leftBorder = $tag(div, "MiddleLeft"),
+          $content,
+          $rightBorder = $tag(div, "MiddleRight")
+        ),
+        $tag(div, false, 'clear:left').append(
+          $tag(div, "BottomLeft"),
+          $bottomBorder = $tag(div, "BottomCenter"),
+          $tag(div, "BottomRight")
+        )
+      ).find('div div').css({'float': 'left'});
+
+      $loadingBay = $tag(div, false, 'position:absolute; width:9999px; visibility:hidden; display:none; max-width:none;');
+
+      $groupControls = $next.add($prev).add($current).add($slideshow);
+
+      $(document.body).append($overlay, $box.append($wrap, $loadingBay));
+    }
+  }
+
+  // Add Colorbox's event bindings
+  function addBindings() {
+    function clickHandler(e) {
+      // ignore non-left-mouse-clicks and clicks modified with ctrl / command, shift, or alt.
+      // See: http://jacklmoore.com/notes/click-events/
+      if (!(e.which > 1 || e.shiftKey || e.altKey || e.metaKey || e.ctrlKey)) {
+        e.preventDefault();
+        launch(this);
+      }
+    }
+
+    if ($box) {
+      if (!init) {
+        init = true;
+
+        // Anonymous functions here keep the public method from being cached, thereby allowing them to be redefined on the fly.
+        $next.click(function () {
+          publicMethod.next();
+        });
+        $prev.click(function () {
+          publicMethod.prev();
+        });
+        $close.click(function () {
+          publicMethod.close();
+        });
+        $overlay.click(function () {
+          if (settings.get('overlayClose')) {
+            publicMethod.close();
+          }
+        });
+
+        // Key Bindings
+        $(document).bind('keydown.' + prefix, function (e) {
+          var key = e.keyCode;
+          if (open && settings.get('escKey') && key === 27) {
+            e.preventDefault();
+            publicMethod.close();
+          }
+          if (open && settings.get('arrowKey') && $related[1] && !e.altKey) {
+            if (key === 37) {
+              e.preventDefault();
+              $prev.click();
+            } else if (key === 39) {
+              e.preventDefault();
+              $next.click();
+            }
+          }
+        });
+
+        if ($.isFunction($.fn.on)) {
+          // For jQuery 1.7+
+          $(document).on('click.'+prefix, '.'+boxElement, clickHandler);
+        } else {
+          // For jQuery 1.3.x -> 1.6.x
+          // This code is never reached in jQuery 1.9, so do not contact me about 'live' being removed.
+          // This is not here for jQuery 1.9, it's here for legacy users.
+          $('.'+boxElement).live('click.'+prefix, clickHandler);
+        }
+      }
+      return true;
+    }
+    return false;
+  }
+
+  // Don't do anything if Colorbox already exists.
+  if ($.colorbox) {
+    return;
+  }
+
+  // Append the HTML when the DOM loads
+  $(appendHTML);
+
+
+  // ****************
+  // PUBLIC FUNCTIONS
+  // Usage format: $.colorbox.close();
+  // Usage from within an iframe: parent.jQuery.colorbox.close();
+  // ****************
+
+  publicMethod = $.fn[colorbox] = $[colorbox] = function (options, callback) {
+    var settings;
+    var $obj = this;
+
+    options = options || {};
+
+    if ($.isFunction($obj)) { // assume a call to $.colorbox
+      $obj = $('<a/>');
+      options.open = true;
+    } else if (!$obj[0]) { // colorbox being applied to empty collection
+      return $obj;
+    }
+
+
+    if (!$obj[0]) { // colorbox being applied to empty collection
+      return $obj;
+    }
+
+    appendHTML();
+
+    if (addBindings()) {
+
+      if (callback) {
+        options.onComplete = callback;
+      }
+
+      $obj.each(function () {
+        var old = $.data(this, colorbox) || {};
+        $.data(this, colorbox, $.extend(old, options));
+      }).addClass(boxElement);
+
+      settings = new Settings($obj[0], options);
+
+      if (settings.get('open')) {
+        launch($obj[0]);
+      }
+    }
+
+    return $obj;
+  };
+
+  publicMethod.position = function (speed, loadedCallback) {
+    var
+    css,
+    top = 0,
+    left = 0,
+    offset = $box.offset(),
+    scrollTop,
+    scrollLeft;
+
+    $window.unbind('resize.' + prefix);
+
+    // remove the modal so that it doesn't influence the document width/height
+    $box.css({top: -9e4, left: -9e4});
+
+    scrollTop = $window.scrollTop();
+    scrollLeft = $window.scrollLeft();
+
+    if (settings.get('fixed')) {
+      offset.top -= scrollTop;
+      offset.left -= scrollLeft;
+      $box.css({position: 'fixed'});
+    } else {
+      top = scrollTop;
+      left = scrollLeft;
+      $box.css({position: 'absolute'});
+    }
+
+    // keeps the top and left positions within the browser's viewport.
+    if (settings.get('right') !== false) {
+      left += Math.max($window.width() - settings.w - loadedWidth - interfaceWidth - setSize(settings.get('right'), 'x'), 0);
+    } else if (settings.get('left') !== false) {
+      left += setSize(settings.get('left'), 'x');
+    } else {
+      left += Math.round(Math.max($window.width() - settings.w - loadedWidth - interfaceWidth, 0) / 2);
+    }
+
+    if (settings.get('bottom') !== false) {
+      top += Math.max(winheight() - settings.h - loadedHeight - interfaceHeight - setSize(settings.get('bottom'), 'y'), 0);
+    } else if (settings.get('top') !== false) {
+      top += setSize(settings.get('top'), 'y');
+    } else {
+      top += Math.round(Math.max(winheight() - settings.h - loadedHeight - interfaceHeight, 0) / 2);
+    }
+
+    $box.css({top: offset.top, left: offset.left, visibility:'visible'});
+
+    // this gives the wrapper plenty of breathing room so it's floated contents can move around smoothly,
+    // but it has to be shrank down around the size of div#colorbox when it's done.  If not,
+    // it can invoke an obscure IE bug when using iframes.
+    $wrap[0].style.width = $wrap[0].style.height = "9999px";
+
+    function modalDimensions() {
+      $topBorder[0].style.width = $bottomBorder[0].style.width = $content[0].style.width = (parseInt($box[0].style.width,10) - interfaceWidth)+'px';
+      $content[0].style.height = $leftBorder[0].style.height = $rightBorder[0].style.height = (parseInt($box[0].style.height,10) - interfaceHeight)+'px';
+    }
+
+    css = {width: settings.w + loadedWidth + interfaceWidth, height: settings.h + loadedHeight + interfaceHeight, top: top, left: left};
+
+    // setting the speed to 0 if the content hasn't changed size or position
+    if (speed) {
+      var tempSpeed = 0;
+      $.each(css, function(i){
+        if (css[i] !== previousCSS[i]) {
+          tempSpeed = speed;
+          return;
+        }
+      });
+      speed = tempSpeed;
+    }
+
+    previousCSS = css;
+
+    if (!speed) {
+      $box.css(css);
+    }
+
+    $box.dequeue().animate(css, {
+      duration: speed || 0,
+      complete: function () {
+        modalDimensions();
+
+        active = false;
+
+        // shrink the wrapper down to exactly the size of colorbox to avoid a bug in IE's iframe implementation.
+        $wrap[0].style.width = (settings.w + loadedWidth + interfaceWidth) + "px";
+        $wrap[0].style.height = (settings.h + loadedHeight + interfaceHeight) + "px";
+
+        if (settings.get('reposition')) {
+          setTimeout(function () {  // small delay before binding onresize due to an IE8 bug.
+            $window.bind('resize.' + prefix, publicMethod.position);
+          }, 1);
+        }
+
+        if (loadedCallback) {
+          loadedCallback();
+        }
+      },
+      step: modalDimensions
+    });
+  };
+
+  publicMethod.resize = function (options) {
+    var scrolltop;
+
+    if (open) {
+      options = options || {};
+
+      if (options.width) {
+        settings.w = setSize(options.width, 'x') - loadedWidth - interfaceWidth;
+      }
+
+      if (options.innerWidth) {
+        settings.w = setSize(options.innerWidth, 'x');
+      }
+
+      $loaded.css({width: settings.w});
+
+      if (options.height) {
+        settings.h = setSize(options.height, 'y') - loadedHeight - interfaceHeight;
+      }
+
+      if (options.innerHeight) {
+        settings.h = setSize(options.innerHeight, 'y');
+      }
+
+      if (!options.innerHeight && !options.height) {
+        scrolltop = $loaded.scrollTop();
+        $loaded.css({height: "auto"});
+        settings.h = $loaded.height();
+      }
+
+      $loaded.css({height: settings.h});
+
+      if(scrolltop) {
+        $loaded.scrollTop(scrolltop);
+      }
+
+      publicMethod.position(settings.get('transition') === "none" ? 0 : settings.get('speed'));
+    }
+  };
+
+  publicMethod.prep = function (object) {
+    if (!open) {
+      return;
+    }
+
+    var callback, speed = settings.get('transition') === "none" ? 0 : settings.get('speed');
+
+    $loaded.remove();
+
+    $loaded = $tag(div, 'LoadedContent').append(object);
+
+    function getWidth() {
+      settings.w = settings.w || $loaded.width();
+      settings.w = settings.mw && settings.mw < settings.w ? settings.mw : settings.w;
+      return settings.w;
+    }
+    function getHeight() {
+      settings.h = settings.h || $loaded.height();
+      settings.h = settings.mh && settings.mh < settings.h ? settings.mh : settings.h;
+      return settings.h;
+    }
+
+    $loaded.hide()
+    .appendTo($loadingBay.show())// content has to be appended to the DOM for accurate size calculations.
+    .css({width: getWidth(), overflow: settings.get('scrolling') ? 'auto' : 'hidden'})
+    .css({height: getHeight()})// sets the height independently from the width in case the new width influences the value of height.
+    .prependTo($content);
+
+    $loadingBay.hide();
+
+    // floating the IMG removes the bottom line-height and fixed a problem where IE miscalculates the width of the parent element as 100% of the document width.
+
+    $(photo).css({'float': 'none'});
+
+    setClass(settings.get('className'));
+
+    callback = function () {
+      var total = $related.length,
+        iframe,
+        complete;
+
+      if (!open) {
+        return;
+      }
+
+      function removeFilter() { // Needed for IE8 in versions of jQuery prior to 1.7.2
+        if ($.support.opacity === false) {
+          $box[0].style.removeAttribute('filter');
+        }
+      }
+
+      complete = function () {
+        clearTimeout(loadingTimer);
+        $loadingOverlay.hide();
+        trigger(event_complete);
+        settings.get('onComplete');
+      };
+
+
+      $title.html(settings.get('title')).show();
+      $loaded.show();
+
+      if (total > 1) { // handle grouping
+        if (typeof settings.get('current') === "string") {
+          $current.html(settings.get('current').replace('{current}', index + 1).replace('{total}', total)).show();
+        }
+
+        $next[(settings.get('loop') || index < total - 1) ? "show" : "hide"]().html(settings.get('next'));
+        $prev[(settings.get('loop') || index) ? "show" : "hide"]().html(settings.get('previous'));
+
+        slideshow();
+
+        // Preloads images within a rel group
+        if (settings.get('preloading')) {
+          $.each([getIndex(-1), getIndex(1)], function(){
+            var img,
+              i = $related[this],
+              settings = new Settings(i, $.data(i, colorbox)),
+              src = settings.get('href');
+
+            if (src && isImage(settings, src)) {
+              src = retinaUrl(settings, src);
+              img = document.createElement('img');
+              img.src = src;
+            }
+          });
+        }
+      } else {
+        $groupControls.hide();
+      }
+
+      if (settings.get('iframe')) {
+        iframe = document.createElement('iframe');
+
+        if ('frameBorder' in iframe) {
+          iframe.frameBorder = 0;
+        }
+
+        if ('allowTransparency' in iframe) {
+          iframe.allowTransparency = "true";
+        }
+
+        if (!settings.get('scrolling')) {
+          iframe.scrolling = "no";
+        }
+
+        $(iframe)
+          .attr({
+            src: settings.get('href'),
+            name: (new Date()).getTime(), // give the iframe a unique name to prevent caching
+            'class': prefix + 'Iframe',
+            allowFullScreen : true // allow HTML5 video to go fullscreen
+          })
+          .one('load', complete)
+          .appendTo($loaded);
+
+        $events.one(event_purge, function () {
+          iframe.src = "//about:blank";
+        });
+
+        if (settings.get('fastIframe')) {
+          $(iframe).trigger('load');
+        }
+      } else {
+        complete();
+      }
+
+      if (settings.get('transition') === 'fade') {
+        $box.fadeTo(speed, 1, removeFilter);
+      } else {
+        removeFilter();
+      }
+    };
+
+    if (settings.get('transition') === 'fade') {
+      $box.fadeTo(speed, 0, function () {
+        publicMethod.position(0, callback);
+      });
+    } else {
+      publicMethod.position(speed, callback);
+    }
+  };
+
+  function load () {
+    var href, setResize, prep = publicMethod.prep, $inline, request = ++requests;
+
+    active = true;
+
+    photo = false;
+
+    trigger(event_purge);
+    trigger(event_load);
+    settings.get('onLoad');
+
+    settings.h = settings.get('height') ?
+        setSize(settings.get('height'), 'y') - loadedHeight - interfaceHeight :
+        settings.get('innerHeight') && setSize(settings.get('innerHeight'), 'y');
+
+    settings.w = settings.get('width') ?
+        setSize(settings.get('width'), 'x') - loadedWidth - interfaceWidth :
+        settings.get('innerWidth') && setSize(settings.get('innerWidth'), 'x');
+
+    // Sets the minimum dimensions for use in image scaling
+    settings.mw = settings.w;
+    settings.mh = settings.h;
+
+    // Re-evaluate the minimum width and height based on maxWidth and maxHeight values.
+    // If the width or height exceed the maxWidth or maxHeight, use the maximum values instead.
+    if (settings.get('maxWidth')) {
+      settings.mw = setSize(settings.get('maxWidth'), 'x') - loadedWidth - interfaceWidth;
+      settings.mw = settings.w && settings.w < settings.mw ? settings.w : settings.mw;
+    }
+    if (settings.get('maxHeight')) {
+      settings.mh = setSize(settings.get('maxHeight'), 'y') - loadedHeight - interfaceHeight;
+      settings.mh = settings.h && settings.h < settings.mh ? settings.h : settings.mh;
+    }
+
+    href = settings.get('href');
+
+    loadingTimer = setTimeout(function () {
+      $loadingOverlay.show();
+    }, 100);
+
+    if (settings.get('inline')) {
+      var $target = $(href);
+      // Inserts an empty placeholder where inline content is being pulled from.
+      // An event is bound to put inline content back when Colorbox closes or loads new content.
+      $inline = $('<div>').hide().insertBefore($target);
+
+      $events.one(event_purge, function () {
+        $inline.replaceWith($target);
+      });
+
+      prep($target);
+    } else if (settings.get('iframe')) {
+      // IFrame element won't be added to the DOM until it is ready to be displayed,
+      // to avoid problems with DOM-ready JS that might be trying to run in that iframe.
+      prep(" ");
+    } else if (settings.get('html')) {
+      prep(settings.get('html'));
+    } else if (isImage(settings, href)) {
+
+      href = retinaUrl(settings, href);
+
+      photo = new Image();
+
+      $(photo)
+      .addClass(prefix + 'Photo')
+      .bind('error',function () {
+        prep($tag(div, 'Error').html(settings.get('imgError')));
+      })
+      .one('load', function () {
+        if (request !== requests) {
+          return;
+        }
+
+        // A small pause because some browsers will occassionaly report a
+        // img.width and img.height of zero immediately after the img.onload fires
+        setTimeout(function(){
+          var percent;
+
+          $.each(['alt', 'longdesc', 'aria-describedby'], function(i,val){
+            var attr = $(settings.el).attr(val) || $(settings.el).attr('data-'+val);
+            if (attr) {
+              photo.setAttribute(val, attr);
+            }
+          });
+
+          if (settings.get('retinaImage') && window.devicePixelRatio > 1) {
+            photo.height = photo.height / window.devicePixelRatio;
+            photo.width = photo.width / window.devicePixelRatio;
+          }
+
+          if (settings.get('scalePhotos')) {
+            setResize = function () {
+              photo.height -= photo.height * percent;
+              photo.width -= photo.width * percent;
+            };
+            if (settings.mw && photo.width > settings.mw) {
+              percent = (photo.width - settings.mw) / photo.width;
+              setResize();
+            }
+            if (settings.mh && photo.height > settings.mh) {
+              percent = (photo.height - settings.mh) / photo.height;
+              setResize();
+            }
+          }
+
+          if (settings.h) {
+            photo.style.marginTop = Math.max(settings.mh - photo.height, 0) / 2 + 'px';
+          }
+
+          if ($related[1] && (settings.get('loop') || $related[index + 1])) {
+            photo.style.cursor = 'pointer';
+            photo.onclick = function () {
+              publicMethod.next();
+            };
+          }
+
+          photo.style.width = photo.width + 'px';
+          photo.style.height = photo.height + 'px';
+          prep(photo);
+        }, 1);
+      });
+
+      photo.src = href;
+
+    } else if (href) {
+      $loadingBay.load(href, settings.get('data'), function (data, status) {
+        if (request === requests) {
+          prep(status === 'error' ? $tag(div, 'Error').html(settings.get('xhrError')) : $(this).contents());
+        }
+      });
+    }
+  }
+
+  // Navigates to the next page/image in a set.
+  publicMethod.next = function () {
+    if (!active && $related[1] && (settings.get('loop') || $related[index + 1])) {
+      index = getIndex(1);
+      launch($related[index]);
+    }
+  };
+
+  publicMethod.prev = function () {
+    if (!active && $related[1] && (settings.get('loop') || index)) {
+      index = getIndex(-1);
+      launch($related[index]);
+    }
+  };
+
+  // Note: to use this within an iframe use the following format: parent.jQuery.colorbox.close();
+  publicMethod.close = function () {
+    if (open && !closing) {
+
+      closing = true;
+      open = false;
+      trigger(event_cleanup);
+      settings.get('onCleanup');
+      $window.unbind('.' + prefix);
+      $overlay.fadeTo(settings.get('fadeOut') || 0, 0);
+
+      $box.stop().fadeTo(settings.get('fadeOut') || 0, 0, function () {
+        $box.hide();
+        $overlay.hide();
+        trigger(event_purge);
+        $loaded.remove();
+
+        setTimeout(function () {
+          closing = false;
+          trigger(event_closed);
+          settings.get('onClosed');
+        }, 1);
+      });
+    }
+  };
+
+  // Removes changes Colorbox made to the document, but does not remove the plugin.
+  publicMethod.remove = function () {
+    if (!$box) { return; }
+
+    $box.stop();
+    $.colorbox.close();
+    $box.stop(false, true).remove();
+    $overlay.remove();
+    closing = false;
+    $box = null;
+    $('.' + boxElement)
+      .removeData(colorbox)
+      .removeClass(boxElement);
+
+    $(document).unbind('click.'+prefix).unbind('keydown.'+prefix);
+  };
+
+  // A method for fetching the current element Colorbox is referencing.
+  // returns a jQuery object.
+  publicMethod.element = function () {
+    return $(settings.el);
+  };
+
+  publicMethod.settings = defaults;
+
+}(jQuery, document, window));