├── HOWTO.md ├── LICENSE ├── README.md └── jquery.cross-slide.js /HOWTO.md: -------------------------------------------------------------------------------- 1 | # CrossSlide 2 | 3 | CrossSlide is a jQuery plugin that can create a few different slideshow effects, depending on how it's called, without using any binary browser plugins. 4 | 5 | Please notice that **this code is unmaintained and unsupported.** 6 | See the [README](README.md) file for details. 7 | 8 | ## Static cross-fade 9 | 10 | The simplest effect, a cross-fade between static pictures, is just as simple to set up: 11 | 12 | $('#placeholder').crossSlide({ 13 | sleep: 2, 14 | fade: 1 15 | }, [ 16 | { src: 'sand-castle.jpeg' }, 17 | { src: 'sunflower.jpeg' }, 18 | { src: 'flip-flops.jpeg' }, 19 | { src: 'rubber-ring.jpeg' } 20 | ]); 21 | 22 | 23 | `#placeholder` is the block-level element (such as a `div`) whose contents will be replaced with the animation. This element should have its width and height fixed in the CSS, even when emptied of all contents. What you put inside it in your HTML is only shown while the images are being preloaded, or if the user-agent has JavaScript turned off. The current version of CrossSlide waits until all the images are preloaded before starting the slideshow, so I usually put the first image as a background-image of the div, so that users with a slow connection won't see a big hole in the website while all the images are being loaded. 24 | 25 | The first parameter to the `crossSlide()` function call is a dictionary of options. The second parameter is an array of objects, defining the sequence of pictures, each with its source path and various attributes. 26 | 27 | To get the static cross-fade effect you must specify the `sleep` option, which is the time every image will take on its own, and the `fade` option, which is the duration of each cross-fade animation between images. Both are expressed in seconds and can accept decimal values. 28 | 29 | ## Slide and cross-fade 30 | 31 | This is the kind of animation from which the plugin takes its name. It shows a sequence of pictures moving at a constant speed in alternating directions, with a cross-fade effect between any two pictures. 32 | 33 | Here is the jQuery code to set it up: 34 | 35 | $('#placeholder').crossSlide({ 36 | speed: 45, 37 | fade: 1 38 | }, [ 39 | { src: 'sand-castle.jpeg', dir: 'up' }, 40 | { src: 'sunflower.jpeg', dir: 'down' }, 41 | { src: 'flip-flops.jpeg', dir: 'up' }, 42 | { src: 'rubber-ring.jpeg', dir: 'down' } 43 | ]); 44 | 45 | 46 | Notice how the `speed` parameter, expressed in pixels/second, has taken the place of `sleep`, as the images aren't static anymore, but move with constant speed. `fade` is still required and still expressed in seconds. You cannot use both `speed` and `sleep` at the same time, because they trigger different effects. 47 | 48 | Additionally you have to specify the direction in which each image should be moving. The plugin computes the rest, panning each image edge-to-egde at the desired speed, in the desired direction. `dir` must be one of `up`, `down`, `left` or `right`. For best results I recommend using an even number of pictures and alternating directions, as in the example. 49 | 50 | ## Ken Burns effect 51 | 52 | Finally, CrossSlide can be brought up to the full visual power of a so-called Ken Burns effect: panning, zooming and fading each image to specific points, to guide the eye of the viewer and convey meaning. 53 | 54 | In this case the jQuery code is a bit more complex, because it shows a number of features: 55 | 56 | $('#placeholder').crossSlide({ 57 | fade: 1 58 | }, [ 59 | { 60 | src: 'sand-castle.jpeg', 61 | alt: 'Sand Castle', 62 | from: '100% 80% 1x', 63 | to: '100% 0% 1.7x', 64 | time: 3 65 | }, { 66 | src: 'sunflower.jpeg', 67 | alt: 'Sunflower', 68 | from: 'top left', 69 | to: 'bottom right 1.5x', 70 | time: 2 71 | }, { 72 | src: 'flip-flops.jpeg', 73 | alt: 'Flip Flops', 74 | from: '100% 80% 1.5x', 75 | to: '80% 0% 1.1x', 76 | time: 2 77 | }, { 78 | src: 'rubber-ring.jpeg', 79 | alt: 'Rubber Ring', 80 | from: '100% 50%', 81 | to: '30% 50% 1.5x', 82 | time: 2 83 | } 84 | ], function(idx, img, idxOut, imgOut) { 85 | if (idxOut == undefined) { 86 | // starting single image phase, put up caption 87 | $('div.caption').text(img.alt).animate({opacity: .7}) 88 | } else { 89 | // starting cross-fade phase, take out caption 90 | $('div.caption').fadeOut() 91 | } 92 | }); 93 | 94 | Every picture's pan & zoom effect will last for `time` seconds plus the two cross-fades, each taking an additional `fade` seconds. `from` and `to` define the starting and ending points of the effect, including the cross-fade part. They are expressed as a background-position value, following the syntax of the CSS property of the same name, plus an optional zoom factor. The zoom defaults to 1x if not provided. The background-position part only accepts keywords and percent values, lengths are not supported. As in CSS, the percentages are interpreted as horizontal followed by vertical, while the keywords can be put in any order. 95 | 96 | Every picture can be made a hyperlink, by adding a `href` parameter with a relative or absolute URI to the option dictionary of the single picture. You can also add an `onclick` parameter, pointing to a function that will handle click events; `alt` to supply the alternate text; and `target` to specify the target frame. 97 | 98 | Other options you can put in the global dictionary are: `loop` (numeric) to have the animation loop just once, or a fixed number of times, and then stop; `shuffle` (boolean) to have CrossSlide automatically shuffle the images before starting the slideshow; and `doubleFade` (boolean) to have both a fade-out and a fade-in effect when switching images (this is useful with transparent images.) 99 | 100 | As shown in this example, CrossSlide accepts a callback function as a third argument. This callback will be invoked at every keyframe, meaning when an image starts to be cross-faded with another, and when the cross-fade ends and a single image remains on screen. The callback will be passed either 2 or 4 arguments, depending on the phase of the animation. If we are at the beginning of a single image-phase, the callback will be passed 2 arguments: the index of the image in the array and the object currently being animated. If we are at the beginning of a cross-fade, the callback will be passed 4 arguments: index and img element of the incoming image, plus index and img element of the outgoing image. You can see how the example exploits this fact to show a textual caption. 101 | 102 | Finally, there are 5 methods you can invoke at runtime on the same object you invoked `crossSlide()` on, to control the animation. The first 3 use jQuery standard functions. The pause and resume methods, on the other hand, require an extension to jQuery's animation facility, in the form of my own [jQuery Pause plugin][1]. 103 | 104 | * `crossSlideFreeze()` will freeze the slideshow, using jQuery's `stop()` method, leaving the images in the position they where when you called it. 105 | * `crossSlideStop()` will stop the slideshow and empty the container `div`; if the container was assigned a static background image or color by css, it will show through. 106 | * `crossSlideRestart()` will stop the slideshow, if needed, and restart it from the beginning. 107 | * `crossSlidePause()` will pause the slideshow. 108 | * `crossSlideResume()` will resume a paused slideshow. 109 | 110 | ## Ken Burns variant 111 | 112 | There is a variant to the Ken Burns effect that does away with the cross-fade between moving images, which is the phase most demanding on the browser's rendering engine. 113 | 114 | This effect is turned on with the `variant` option. To get a pleasing effect in this variant, a linear animation is not appropriate for the single-image phase, so CrossSlide defaults to jQuery's built-in `swing` mode. You can choose a different easing effect with the `easing` option, which will be applied to single-image phases only: cross-fade phases are still rendered with a linear animation. In this example I'm using `easeInOutQuad` from George McGinley Smith's [jQuery Easing Plugin][2]. 115 | 116 | $('#placeholder').crossSlide({ 117 | fade: 1, 118 | variant: true, 119 | easing: 'easeInOutQuad' 120 | }, [ 121 | // as above 122 | ]); 123 | 124 | ## How to use it 125 | 126 | Here are basic instructions on how to get CrossSlide to work: 127 | 128 | 1. Download the jQuery library and include it in your page along with my plugin. 129 | 2. Put a block element somewhere in your page and give it a fixed size, even when emptied of its contents, by setting its width and height in the CSS stylesheet. 130 | 4. Open a script tag, define a jQuery *document ready handler* and activate my plugin on the element you created in step 2. 131 | 132 | ## Things to keep in mind: 133 | 134 | * Keep an eye on the Error console, as that's where my script will post any error messages you are supposed to read, for example when the options you use don't make sense together. 135 | * Make sure the browser can find the images you reference in the `src` attributes, relative to the path of the current page, because if the browser cannot load them, my plugin has no way to know and will just hang there, without any error messages. 136 | * Don't put a comma after the last element in an array or object (this means don't put a comma just before a closing brace or bracket, even if it's on the previous line) because Internet Explorer won't like it and will refuse to run the script, again without any error message. 137 | * Don't call `crossSlide()` on an empty set or on a set of more than one element. This is not supported and will raise an exception. 138 | 139 | [1]: http://tobia.github.com/Pause/ 140 | [2]: http://gsgd.co.uk/sandbox/jquery/easing/ 141 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CrossSlide 2 | 3 | CrossSlide was a jQuery plugin I developed in 2007 to create slideshow animations using plain Javascript, doing away with the need to use Adobe Flash™ or other binary plugins. 4 | 5 | It did so by creating a `` container that would hold several `` elements, so that the images could be moved around inside the container while staying clipped to the container's edges. It would then build a chain of *closures* that would call jQuery's `animate()` method for each animation phase, between each pair of keyframes, passing around the callback for the next phase. This was before jQuery's support for animation queues. 6 | 7 | **This code is obsolete** in more that one way. There are much better alternatives around to build slideshows without using binary plugins, including CSS3 animations and the Canvas element. Therefore **this plugin is unmaintained and unsupported**. 8 | 9 | In other words, **2007 called and wants its Javascript back**. CrossSlide users are encouraged to switch to one of the current slideshow packages, built on modern technologies. 10 | 11 | That being said, this project was released under the GPLv2 license, so anyone is free to fork it and continue development as they see fit. You can see any existing forks in the upper right corner of this project page. 12 | 13 | _–Tobia_ 14 | -------------------------------------------------------------------------------- /jquery.cross-slide.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * CrossSlide jQuery plugin v0.6.2 3 | * 4 | * Copyright 2007-2010 by Tobia Conforto 5 | * 6 | * This program is free software; you can redistribute it and/or modify it 7 | * under the terms of the GNU General Public License as published by the Free 8 | * Software Foundation; either version 2 of the License, or (at your option) 9 | * any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, but WITHOUT 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 14 | * more details. 15 | * 16 | * You should have received a copy of the GNU General Public License along with 17 | * this program; if not, write to the Free Software Foundation, Inc., 51 18 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 19 | */ 20 | /* Changelog: 21 | * 22 | * 0.6.2 2010-09-29 Added support for rel attribute 23 | * 0.6.1 2010-08-02 Bugfixes 24 | * 0.6 2010-07-03 Variant Ken Burns effect 25 | * 0.5 2010-06-13 Support for animation control and event callbacks 26 | * 0.4.2 2010-06-07 Bugfix 27 | * 0.4.1 2010-06-04 Added target option 28 | * 0.4 2010-05-20 Better error reporting, published on GitHub 29 | * 0.3.7 2009-05-14 Fixed bug when container div's CSS position is not set 30 | * 0.3.6 2009-04-16 Added alt option 31 | * 0.3.5 2009-03-12 Fixed usage of href parameter in 'Ken Burns' mode 32 | * 0.3.4 2009-03-12 Added shuffle option, 33 | * contrib. by Ralf Santbergen 34 | * 0.3.3 2008-12-14 Added onclick option 35 | * 0.3.2 2008-11-11 Fixed CSS bugs, contrib. by Erwin Bot 36 | * 0.3.1 2008-11-11 Better error messages 37 | * 0.3 2008-10-22 Option to repeat the animation a fixed number of times 38 | * 0.2 2008-10-15 Linkable images, contrib. by Tim Rainey 39 | * 0.1.1 2008-09-18 Compatibility with prototype.js 40 | * 0.1 2008-08-21 Re-released under GPL v2 41 | * 0.1 2007-08-19 Initial release 42 | */ 43 | 44 | (function() { 45 | var $ = jQuery, 46 | animate = ($.fn.startAnimation ? 'startAnimation' : 'animate'), 47 | pause_missing = 'pause plugin missing.'; 48 | 49 | // utility to format a string with {0}, {1}... placeholders 50 | function format(str) { 51 | for (var i = 1; i < arguments.length; i++) 52 | str = str.replace(new RegExp('\\{' + (i-1) + '}', 'g'), arguments[i]); 53 | return str; 54 | } 55 | 56 | // utility to abort with a message to the error console 57 | function abort() { 58 | arguments[0] = 'CrossSlide: ' + arguments[0]; 59 | throw new Error(format.apply(null, arguments)); 60 | } 61 | 62 | // utility to parse "from" and "to" parameters 63 | function parse_position_param(param) { 64 | var zoom = 1; 65 | var tokens = param.replace(/^\s*|\s*$/g, '').split(/\s+/); 66 | if (tokens.length > 3) throw new Error(); 67 | if (tokens[0] == 'center') 68 | if (tokens.length == 1) 69 | tokens = ['center', 'center']; 70 | else if (tokens.length == 2 && tokens[1].match(/^[\d.]+x$/i)) 71 | tokens = ['center', 'center', tokens[1]]; 72 | if (tokens.length == 3) 73 | zoom = parseFloat(tokens[2].match(/^([\d.]+)x$/i)[1]); 74 | var pos = tokens[0] + ' ' + tokens[1]; 75 | if (pos == 'left top' || pos == 'top left') 76 | return { xrel: 0, yrel: 0, zoom: zoom }; 77 | if (pos == 'left center' || pos == 'center left') 78 | return { xrel: 0, yrel: .5, zoom: zoom }; 79 | if (pos == 'left bottom' || pos == 'bottom left') 80 | return { xrel: 0, yrel: 1, zoom: zoom }; 81 | if (pos == 'center top' || pos == 'top center') 82 | return { xrel: .5, yrel: 0, zoom: zoom }; 83 | if (pos == 'center center') 84 | return { xrel: .5, yrel: .5, zoom: zoom }; 85 | if (pos == 'center bottom' || pos == 'bottom center') 86 | return { xrel: .5, yrel: 1, zoom: zoom }; 87 | if (pos == 'right top' || pos == 'top right') 88 | return { xrel: 1, yrel: 0, zoom: zoom }; 89 | if (pos == 'right center' || pos == 'center right') 90 | return { xrel: 1, yrel: .5, zoom: zoom }; 91 | if (pos == 'right bottom' || pos == 'bottom right') 92 | return { xrel: 1, yrel: 1, zoom: zoom }; 93 | return { 94 | xrel: parseInt(tokens[0].match(/^(\d+)%$/)[1]) / 100, 95 | yrel: parseInt(tokens[1].match(/^(\d+)%$/)[1]) / 100, 96 | zoom: zoom 97 | }; 98 | } 99 | 100 | $.fn.crossSlide = function(opts, plan, callback) 101 | { 102 | var self = this, 103 | self_width = this.width(), 104 | self_height = this.height(); 105 | 106 | // must be called on exactly 1 element 107 | if (self.length != 1) 108 | abort('crossSlide() must be called on exactly 1 element') 109 | 110 | // saving params for crossSlide.restart 111 | self.get(0).crossSlideArgs = [ opts, plan, callback ]; 112 | 113 | // make working copy of plan 114 | plan = $.map(plan, function(p) { 115 | return $.extend({}, p); 116 | }); 117 | 118 | // options with default values 119 | if (! opts.easing) 120 | opts.easing = opts.variant ? 'swing' : 'linear'; 121 | if (! callback) 122 | callback = function() {}; 123 | 124 | // first preload all the images, while getting their actual width and height 125 | (function(proceed) { 126 | 127 | var n_loaded = 0; 128 | function loop(i, img) { 129 | // this loop is a for (i = 0; i < plan.length; i++) 130 | // with independent var i, img (for the onload closures) 131 | img.onload = function(e) { 132 | n_loaded++; 133 | plan[i].width = img.width; 134 | plan[i].height = img.height; 135 | if (n_loaded == plan.length) 136 | proceed(); 137 | } 138 | img.src = plan[i].src; 139 | if (i + 1 < plan.length) 140 | loop(i + 1, new Image()); 141 | } 142 | loop(0, new Image()); 143 | 144 | })(function() { // then proceed 145 | 146 | // check global params 147 | if (! opts.fade) 148 | abort('missing fade parameter.'); 149 | if (opts.speed && opts.sleep) 150 | abort('you cannot set both speed and sleep at the same time.'); 151 | 152 | // conversion from sec to ms; from px/sec to px/ms 153 | var fade_ms = Math.round(opts.fade * 1000); 154 | if (opts.sleep) 155 | var sleep = Math.round(opts.sleep * 1000); 156 | if (opts.speed) 157 | var speed = opts.speed / 1000, 158 | fade_px = Math.round(fade_ms * speed); 159 | 160 | // set container css 161 | self.empty().css({ 162 | overflow: 'hidden', 163 | padding: 0 164 | }); 165 | if (! /^(absolute|relative|fixed)$/.test(self.css('position'))) 166 | self.css({ position: 'relative' }); 167 | if (! self.width() || ! self.height()) 168 | abort('container element does not have its own width and height'); 169 | 170 | // random sorting 171 | if (opts.shuffle) 172 | plan.sort(function() { 173 | return Math.random() - 0.5; 174 | }); 175 | 176 | // prepare each image 177 | for (var i = 0; i < plan.length; ++i) { 178 | 179 | var p = plan[i]; 180 | if (! p.src) 181 | abort('missing src parameter in picture {0}.', i + 1); 182 | 183 | if (speed) { // speed/dir mode 184 | 185 | // check parameters and translate speed/dir mode into full mode 186 | // (from/to/time) 187 | switch (p.dir) { 188 | case 'up': 189 | p.from = { xrel: .5, yrel: 0, zoom: 1 }; 190 | p.to = { xrel: .5, yrel: 1, zoom: 1 }; 191 | var slide_px = p.height - self_height - 2 * fade_px; 192 | break; 193 | case 'down': 194 | p.from = { xrel: .5, yrel: 1, zoom: 1 }; 195 | p.to = { xrel: .5, yrel: 0, zoom: 1 }; 196 | var slide_px = p.height - self_height - 2 * fade_px; 197 | break; 198 | case 'left': 199 | p.from = { xrel: 0, yrel: .5, zoom: 1 }; 200 | p.to = { xrel: 1, yrel: .5, zoom: 1 }; 201 | var slide_px = p.width - self_width - 2 * fade_px; 202 | break; 203 | case 'right': 204 | p.from = { xrel: 1, yrel: .5, zoom: 1 }; 205 | p.to = { xrel: 0, yrel: .5, zoom: 1 }; 206 | var slide_px = p.width - self_width - 2 * fade_px; 207 | break; 208 | default: 209 | abort('missing or malformed dir parameter in picture {0}.', i+1); 210 | } 211 | if (slide_px <= 0) 212 | abort('impossible animation: either picture {0} is too small or ' 213 | + 'div is too large or fade duration too long.', i + 1); 214 | p.time_ms = Math.round(slide_px / speed); 215 | 216 | } else if (! sleep) { // full mode 217 | 218 | // check and parse parameters 219 | if (! p.from || ! p.to || ! p.time) 220 | abort('missing either speed/sleep option, or from/to/time params ' 221 | + 'in picture {0}.', i + 1); 222 | try { 223 | p.from = parse_position_param(p.from) 224 | } catch (e) { 225 | abort('malformed "from" parameter in picture {0}.', i + 1); 226 | } 227 | try { 228 | p.to = parse_position_param(p.to) 229 | } catch (e) { 230 | abort('malformed "to" parameter in picture {0}.', i + 1); 231 | } 232 | if (! p.time) 233 | abort('missing "time" parameter in picture {0}.', i + 1); 234 | p.time_ms = Math.round(p.time * 1000) 235 | } 236 | 237 | // precalculate left/top/width/height bounding values 238 | if (p.from) 239 | $.each([ p.from, p.to ], function(i, each) { 240 | each.width = Math.round(p.width * each.zoom); 241 | each.height = Math.round(p.height * each.zoom); 242 | each.left = Math.round((self_width - each.width) * each.xrel); 243 | each.top = Math.round((self_height - each.height) * each.yrel); 244 | }); 245 | 246 | // append the image (or anchor) element to the container 247 | var img, elm; 248 | elm = img = $(format('', p.src)); 249 | if (p.href) 250 | elm = $(format('', p.href)).append(img); 251 | if (p.onclick) 252 | elm.click(p.onclick); 253 | if (p.alt) 254 | img.attr('alt', p.alt); 255 | if (p.rel) 256 | elm.attr('rel', p.rel); 257 | if (p.href && p.target) 258 | elm.attr('target', p.target); 259 | elm.appendTo(self); 260 | } 261 | delete speed; // speed mode has now been translated to full mode 262 | 263 | // utility to compute the css for a given phase between p.from and p.to 264 | // 0: begin fade-in, 1: end fade-in, 2: begin fade-out, 3: end fade-out 265 | function position_to_css(p, phase) { 266 | var pos = [ 0, fade_ms / (p.time_ms + 2 * fade_ms), 267 | 1 - fade_ms / (p.time_ms + 2 * fade_ms), 1 ][phase]; 268 | return { 269 | left: Math.round(p.from.left + pos * (p.to.left - p.from.left)), 270 | top: Math.round(p.from.top + pos * (p.to.top - p.from.top)), 271 | width: Math.round(p.from.width + pos * (p.to.width - p.from.width)), 272 | height: Math.round(p.from.height + pos * (p.to.height-p.from.height)) 273 | }; 274 | } 275 | 276 | // find images to animate and set initial css attributes 277 | var imgs = self.find('img').css({ 278 | position: 'absolute', 279 | visibility: 'hidden', 280 | top: 0, 281 | left: 0, 282 | border: 0 283 | }); 284 | 285 | // show first image 286 | imgs.eq(0).css({ visibility: 'visible' }); 287 | if (! sleep) 288 | imgs.eq(0).css(position_to_css(plan[0], opts.variant ? 0 : 1)); 289 | 290 | // create animation chain 291 | var countdown = opts.loop; 292 | function create_chain(i, chainf) { 293 | // building the chain backwards, or inside out 294 | 295 | if (i % 2 == 0) { 296 | if (sleep) { 297 | // single image sleep 298 | var i_sleep = i / 2, 299 | i_hide = (i_sleep - 1 + plan.length) % plan.length, 300 | img_sleep = imgs.eq(i_sleep), 301 | img_hide = imgs.eq(i_hide); 302 | var newf = function() { 303 | callback(i_sleep, img_sleep.get(0)); 304 | img_hide.css('visibility', 'hidden'); 305 | setTimeout(chainf, sleep); 306 | }; 307 | } else { 308 | // single image animation 309 | var i_slide = i / 2, 310 | i_hide = (i_slide - 1 + plan.length) % plan.length, 311 | img_slide = imgs.eq(i_slide), 312 | img_hide = imgs.eq(i_hide), 313 | time = plan[i_slide].time_ms, 314 | slide_anim = position_to_css(plan[i_slide], 315 | opts.variant ? 3 : 2); 316 | var newf = function() { 317 | callback(i_slide, img_slide.get(0)); 318 | img_hide.css('visibility', 'hidden'); 319 | img_slide[animate](slide_anim, time, opts.easing, chainf); 320 | }; 321 | } 322 | } else { 323 | // double image animation 324 | var i_from = Math.floor(i / 2), 325 | i_to = Math.ceil(i / 2) % plan.length, 326 | img_from = imgs.eq(i_from), 327 | img_to = imgs.eq(i_to), 328 | from_anim = {}, 329 | to_init = { visibility: 'visible' }, 330 | to_anim = {}; 331 | if (i_to > i_from) { 332 | to_init.opacity = 0; 333 | to_anim.opacity = 1; 334 | if (opts.doubleFade) 335 | from_anim.opacity = 0; 336 | } else { 337 | from_anim.opacity = 0; 338 | if (opts.doubleFade) { 339 | to_init.opacity = 0; 340 | to_anim.opacity = 1; 341 | } 342 | } 343 | if (! sleep) { 344 | // moving images 345 | $.extend(to_init, position_to_css(plan[i_to], 0)); 346 | if (! opts.variant) { 347 | $.extend(from_anim, position_to_css(plan[i_from], 3)); 348 | $.extend(to_anim, position_to_css(plan[i_to], 1)); 349 | } 350 | } 351 | if ($.isEmptyObject(to_anim)) { 352 | var newf = function() { 353 | callback(i_to, img_to.get(0), i_from, img_from.get(0)); 354 | img_to.css(to_init); 355 | img_from[animate](from_anim, fade_ms, 'linear', chainf); 356 | }; 357 | } else if ($.isEmptyObject(from_anim)) { 358 | var newf = function() { 359 | callback(i_to, img_to.get(0), i_from, img_from.get(0)); 360 | img_to.css(to_init); 361 | img_to[animate](to_anim, fade_ms, 'linear', chainf); 362 | }; 363 | } else { 364 | var newf = function() { 365 | callback(i_to, img_to.get(0), i_from, img_from.get(0)); 366 | img_to.css(to_init); 367 | img_to[animate](to_anim, fade_ms, 'linear'); 368 | img_from[animate](from_anim, fade_ms, 'linear', chainf); 369 | }; 370 | } 371 | } 372 | 373 | // if the loop option was requested, push a countdown check 374 | if (opts.loop && i == plan.length * 2 - 2) { 375 | var newf_orig = newf; 376 | newf = function() { 377 | if (--countdown) newf_orig(); 378 | } 379 | } 380 | 381 | if (i > 0) 382 | return create_chain(i - 1, newf); 383 | else 384 | return newf; 385 | } 386 | var animation = create_chain(plan.length * 2 - 1, 387 | function() { return animation(); }); 388 | 389 | // start animation 390 | animation(); 391 | }); 392 | return self; 393 | }; 394 | 395 | $.fn.crossSlideFreeze = function() 396 | { 397 | this.find('img').stop(); 398 | } 399 | 400 | $.fn.crossSlideStop = function() 401 | { 402 | this.find('img').stop().remove(); 403 | } 404 | 405 | $.fn.crossSlideRestart = function() 406 | { 407 | this.find('img').stop().remove(); 408 | $.fn.crossSlide.apply(this, this.get(0).crossSlideArgs); 409 | } 410 | 411 | $.fn.crossSlidePause = function() 412 | { 413 | if (! $.fn.pause) 414 | abort(pause_missing); 415 | this.find('img').pause(); 416 | } 417 | 418 | $.fn.crossSlideResume = function() 419 | { 420 | if (! $.fn.pause) 421 | abort(pause_missing); 422 | this.find('img').resume(); 423 | } 424 | })(); 425 | --------------------------------------------------------------------------------