|
| 1 | +jAlert v3 |
| 2 | +====== |
| 3 | +by Versatility Werks http://flwebsites.biz |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +Demo & Detailed Docs |
| 8 | +======= |
| 9 | +http://flwebsites.biz/jAlert/ |
| 10 | + |
| 11 | +What is it? |
| 12 | +======= |
| 13 | +Simple jQuery (Modal | Popup | Lightbox | Alert) Plugin |
| 14 | + |
| 15 | +Whether you call it a lightbox, modal, popup, or window, jAlert is an excellent replacement / alternative for Simple Modal, FancyBox, or Reveal. |
| 16 | + |
| 17 | + |
| 18 | +Setup |
| 19 | +====== |
| 20 | +Include the CSS files from the src folder in the head section: |
| 21 | +```html |
| 22 | +<link rel="stylesheet" href="jAlert-master/src/jAlert-v3.css"> |
| 23 | +``` |
| 24 | + |
| 25 | +Include the JS file from the src folder before the `</body>`: |
| 26 | +```html |
| 27 | +<script src="jAlert-master/src/jAlert-v3.min.js"></script> |
| 28 | +``` |
| 29 | + |
| 30 | +Basic Use |
| 31 | +======= |
| 32 | +```javascript |
| 33 | + alert('hi'); //override is enabled by default |
| 34 | +``` |
| 35 | +```javascript |
| 36 | + successAlert('Success!', 'You did it!'); //green alert |
| 37 | +``` |
| 38 | +```javascript |
| 39 | + errorAlert('Error!', 'It didn't work!'); //red alert |
| 40 | +``` |
| 41 | +```javascript |
| 42 | + confirm(function(){ //override is enabled by default |
| 43 | + console.log('confirmed!'); |
| 44 | + }, function(){ |
| 45 | + console.log('denied'); |
| 46 | + }); |
| 47 | +``` |
| 48 | +```javascript |
| 49 | + $.jAlert({ //this is the normal usage |
| 50 | + 'title': 'Test', |
| 51 | + 'content': 'Howdy', |
| 52 | + 'theme': 'green', |
| 53 | + 'size': 'xsm' |
| 54 | + }); |
| 55 | +``` |
| 56 | +```javascript |
| 57 | + $.fn.jAlert.defaults.backgroundColor = 'white'; //override a default setting |
| 58 | + |
| 59 | + $.fn.jAlert({ //same as $.jAlert when you're not passing an element - this alert will now have the white background color |
| 60 | + 'title': 'Test', |
| 61 | + 'content': 'Howdy', |
| 62 | + 'theme': 'green', |
| 63 | + 'size': 'xsm' |
| 64 | + //'backgroundColor': 'white' //you could also pass it here |
| 65 | + }); |
| 66 | + |
| 67 | + $.fn.jAlert.defaults.backgroundColor = 'black'; //set it back to black |
| 68 | +``` |
| 69 | +```javascript |
| 70 | + $('.btn').alertOnClick({ //this function attaches an onclick handler to .btn and passes the options to jAlert |
| 71 | + 'title': 'It worked!', |
| 72 | + 'content': 'You clicked the button' |
| 73 | + }); |
| 74 | +``` |
| 75 | +```javascript |
| 76 | + $.alertOnClick('.btn', { //this function attaches an onclick handler to the body for .btn and kicks off jAlert |
| 77 | + 'title': 'Like magic', |
| 78 | + 'content': 'You clicked the button that was dynamically added' |
| 79 | + }); |
| 80 | +``` |
| 81 | +```javascript |
| 82 | + $.jAlert({ //creates a lightbox for the image - responsive and all |
| 83 | + 'image': 'http://mysite.com/my-image.jpg' |
| 84 | + }); |
| 85 | + ``` |
| 86 | +```javascript |
| 87 | + $.jAlert({ //creates a lightbox for the video - responsive and all |
| 88 | + 'video': 'http://youtube.com/dflskd' |
| 89 | + }); |
| 90 | +``` |
| 91 | +```javascript |
| 92 | + $.jAlert({ //creates an alert that fills most of the height with a scrollable iframe |
| 93 | + 'iframe': 'http://mysite.com' |
| 94 | + }); |
| 95 | +``` |
| 96 | +```javascript |
| 97 | + $.jAlert({ //gets content from another file with $.get() |
| 98 | + 'ajax': 'my-ajax-content.php' |
| 99 | + }); |
| 100 | +``` |
| 101 | + |
| 102 | + |
| 103 | +Dependencies |
| 104 | +======= |
| 105 | +jQuery 1.7+ |
| 106 | + |
| 107 | +License |
| 108 | +======= |
| 109 | +M.I.T. |
| 110 | + |
| 111 | +Copyright (c) 2015 Versatility Werks |
| 112 | + |
| 113 | +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
| 114 | + |
| 115 | +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
| 116 | + |
| 117 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
0 commit comments