![\"Paul](\"https://avatars2.githubusercontent.com/u/117288?v=4\")
Paul Straw
📖 💻 🚧
![\"sherwinski\"/](\"https://avatars3.githubusercontent.com/u/15919091?v=4\")
sherwinski
💻 📖 🚧
![\"Frederick](\"https://avatars0.githubusercontent.com/u/615334?v=4\")
Frederick Fogerty
💻 📖 🚧
![\"Jason](\"https://avatars2.githubusercontent.com/u/609840?v=4\")
Jason Eberle
💻 📖 🚧
![](\"http://assets.imgix.net/dog.png?w=400\")
\n\nThis is a simple description of the dog picture.
\n```\n\n```javascript\nnew Drift(document.querySelector(\"img\"), {\n paneContainer: document.querySelector(\"p\")\n});\n```\n\n## Options / Defaults\n\nHere's an example of using Drift with a custom configuration. All of the listed options are displayed with their default value.\n\n```javascript\nvar options = {\n\t// Prefix for generated element class names (e.g. `my-ns` will\n\t// result in classes such as `my-ns-pane`. Default `drift-`\n\t// prefixed classes will always be added as well.\n\tnamespace: null,\n\t// Whether the ZoomPane should show whitespace when near the edges.\n\tshowWhitespaceAtEdges: false,\n\t// Whether the inline ZoomPane should stay inside\n\t// the bounds of its image.\n\tcontainInline: false,\n\t// How much to offset the ZoomPane from the\n\t// interaction point when inline.\n\tinlineOffsetX: 0,\n\tinlineOffsetY: 0,\n\t// A DOM element to append the inline ZoomPane to.\n\tinlineContainer: document.body,\n\t// Which trigger attribute to pull the ZoomPane image source from.\n\tsourceAttribute: 'data-zoom',\n\t// How much to magnify the trigger by in the ZoomPane.\n\t// (e.g., `zoomFactor: 3` will result in a 900 px wide ZoomPane image\n\t// if the trigger is displayed at 300 px wide)\n\tzoomFactor: 3,\n\t// A DOM element to append the non-inline ZoomPane to.\n\t// Required if `inlinePane !== true`.\n\tpaneContainer: document.body,\n\t// When to switch to an inline ZoomPane. This can be a boolean or\n\t// an integer. If `true`, the ZoomPane will always be inline,\n\t// if `false`, it will switch to inline when `windowWidth <= inlinePane`\n\tinlinePane: 375,\n\t// If `true`, touch events will trigger the zoom, like mouse events.\n\thandleTouch: true,\n\t// If present (and a function), this will be called\n\t// whenever the ZoomPane is shown.\n\tonShow: null,\n\t// If present (and a function), this will be called\n\t// whenever the ZoomPane is hidden.\n\tonHide: null,\n\t// Add base styles to the page. See the \"Theming\"\n\t// section of README.md for more information.\n\tinjectBaseStyles: true,\n\t// An optional number that determines how long to wait before\n\t// showing the ZoomPane because of a `mouseenter` event.\n\thoverDelay: 0,\n\t// An optional number that determines how long to wait before\n\t// showing the ZoomPane because of a `touchstart` event.\n\t// Setting this to a reasonable amount will allow users to execute\n\t// scroll-gestures events on touch-enabled devices with the image as\n\t// a starting point\n\ttouchDelay: 0,\n\t// If true, a bounding box will show the area currently being previewed\n\t// during mouse hover\n\thoverBoundingBox: false,\n\t// If true, a bounding box will show the area currently being previewed\n\t// during touch events\n\ttouchBoundingBox: false,\n\t// A DOM element to append the bounding box to.\n\tboundingBoxContainer = document.body,\n};\n\nnew Drift(document.querySelector('img'), options);\n```\n\n## API\n\n### `Drift#disable`\n\nDisable your Drift instance. This will prevent your Drift instance from showing, but will not hide it if it's currently visible.\n\n```javascript\nvar drift = new Drift(document.querySelector(\"img\"), {\n paneContainer: document.querySelector(\"p\")\n});\n\ndocument.querySelector(\".disable-button\").addEventListener(\"click\", function() {\n drift.disable();\n});\n```\n\n### `Drift#enable`\n\nEnable your Drift instance.\n\n```javascript\nvar drift = new Drift(document.querySelector(\"img\"), {\n paneContainer: document.querySelector(\"p\")\n});\n\ndocument.querySelector(\".enable-button\").addEventListener(\"click\", function() {\n drift.enable();\n});\n```\n\n### `Drift#setZoomImageURL(imageURL)`\n\nChange the URL of the zoom image to the passed string. This only has a visible effect while your Drift is currently open. When opening, Drift always pulls the zoom image URL from the specified `sourceAttribute`. If you want to make a \"permanent\" change that will persist after the user leaves and re-enters your Drift trigger, you update its `sourceAttribute` as well (default `data-zoom`). For more information about this method, please see [issue #42](https://github.com/imgix/drift/issues/42).\n\n```javascript\nvar triggerEl = document.querySelector(\"img\");\nvar drift = new Drift(triggerEl, {\n paneContainer: document.querySelector(\"p\")\n});\n\nvar frames = [\"https://mysite.com/frame1.jpg\", \"https://mysite.com/frame2.jpg\", \"https://mysite.com/frame3.jpg\"];\n\nvar currentFrame = 0;\n\nsetInterval(function() {\n currentFrame++;\n\n if (currentFrame > frames.length - 1) {\n currentFrame = 0;\n }\n\n drift.setZoomImageURL(frames[currentFrame]);\n triggerEl.setAttribute(\"data-zoom\", frames[currentFrame]);\n}, 1200);\n```\n\n## Theming\n\nBy default, Drift injects an extremely basic set of styles into the page. You will almost certainly want to extend these basic styles for a prettier, more usable experience that matches your site. There is an included basic theme that may meet your needs, or at least give a good example of how to build out your own custom styles. The `namespace` option can be used as a way to easily apply different themes to specific instances of Drift.\n\nIf you need to do something very out of the ordinary, or just prefer to include the default styles in CSS yourself, you can pass `injectBaseStyles: false` when instantiating a new instance of Drift. Please note that if you disable the included base styles, you will still need to provide an animation for `.drift-window.drift-opening` and `.drift-window.drift-closing` (this can be a \"noop\" style animation, as seen in the base styles source).\n\n## Browser Support\n\nWe support the latest version of Google Chrome (which [automatically updates](https://support.google.com/chrome/answer/95414) whenever it detects that a new version of the browser is available). We also support the current and previous major releases of desktop Firefox, Internet Explorer, and Safari on a rolling basis. Mobile support is tested on the most recent minor version of the current and previous major release for the default browser on iOS and Android (e.g., iOS 9.2 and 8.4). Each time a new version is released, we begin supporting that version and stop supporting the third most recent version.\n\n## Contributors ✨\n\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\nPaul Straw 📖 💻 🚧 | \n sherwinski 💻 📖 🚧 | \n Frederick Fogerty 💻 📖 🚧 | \n Jason Eberle 💻 📖 🚧 | \n