forked from TurnWheel/jReject
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.html
566 lines (493 loc) · 17.6 KB
/
doc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>jReject - jQuery Plugin for Simple Browser Rejection</title>
<meta name="description" content="jReject: jQuery Browser Rejection Plugin" />
<link href="css/jquery.reject.css" rel="stylesheet" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script type="text/javascript" src="js/jquery.reject.js"></script>
<script type="text/javascript">
$(function() {
// Handle external links
$('a[rel="external"]').click(function() {
window.open($(this).attr('href'),'_new');
return false;
});
// Handle show/hide of code
$('h4+pre').show().prev('h4').click(function() {
var self = $(this);
var _next = self.next('pre');
var _show = _next.css('display') == 'none' ? true : false;
// Change displayed text
var _text = _show ? self.text().replace(/Show/,'Hide') :
self.text().replace(/Hide/,'Show');
self.text(_text);
_next.slideToggle();
}).append(' (Click To Hide)');
// Handle displaying of option links
$('em.option').css({
cursor: 'pointer',
fontSize: '1.1em',
color: '#333',
letterSpacing: '1px',
borderBottom: '1px dashed #BBB'
}).click(function() {
var self = $(this);
var opt = $.trim(self.text());
$('ol.dp-c:first').children('li').children('span').each(function() {
var self = $(this);
var text = self.text();
var srch = opt+':';
// If found, highlight and jump window to position on page
if (text.search(srch) !== -1) {
self.css('color','red');
window.location.hash = '#c-'+opt;
window.scrollTo(0,self[0].offsetTop);
}
});
});
/* Demo Codes */
$('#demo1').click(function() {
$.reject(); // Default Settings
return false;
});
$('#demo2').click(function() {
$.reject({
reject: {
safari: true, // Apple Safari
chrome: true, // Google Chrome
firefox: true, // Mozilla Firefox
msie: true, // Microsoft Internet Explorer
opera: true, // Opera
konqueror: true, // Konqueror (Linux)
unknown: true // Everything else
}
}); // Customized Browsers
return false;
});
$('#demo3').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
header: 'Your browser is not supported here', // Header Text
paragraph1: 'You are currently using an unsupported browser', // Paragraph 1
paragraph2: 'Please install one of the many optional browsers below to proceed', // Paragraph 2
closeMessage: 'Close this window at your own demise!' // Message below close window link
}); // Customized Text
return false;
});
$('#demo4').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
display: ['firefox','chrome','opera'] // Displays only firefox, chrome, and opera
});
return false;
});
$('#demo5').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
// Displays only custom "Konqueror" browser, firefox and opera.
display: ['konqueror','firefox','opera'],
browserInfo: {
konqueror: { // Specifies browser name and image name (browser_konqueror.gif)
text: 'Konqueror 4', // Text Link
url: 'http://konqueror.kde.org/' // URL To link to
}
}
});
return false;
});
$('#demo6').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
closeCookie: true // Set cookie to remmember close for this session
});
return false;
});
$('#demo7').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
close: false, // Prevent closing of window
paragraph1: 'You will not be able to close this window', // Warning about closing
paragraph2: 'To exit, you must <a href="javascript:window.location=window.location.pathname;">refresh the page</a>' // Display refresh link
});
return false;
});
$('#demo8').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
beforeReject: function() {
if ($.browser.name === 'chrome') {
this.display = ['firefox','opera'];
}
if ($.os.name === 'iphone' || $.os.name === 'ipad') {
this.browserShow = false;
this.paragraph2 = '';
}
}
});
return false;
});
});
</script>
</head>
<body>
<div id="wrapper">
<h1>jReject: jQuery Browser Rejection</h1>
<p>
<strong>Description:</strong> jReject provides a simple, robjust,
light-weight way to display rejections based on a the browser, specific
browser version, specific platforms, or rendering engine. Provides full
customization of the popup. Uses no CSS file (by default), and can
easily be used on page load or during a specific page event. Also
provides a flexible way to beautifully and cleanly display custom
browser alternatives in the popup.
</p>
<p>
<strong>Depends On:</strong><br />
<a href="http://jquery.com/" rel="external">jQuery 1.5+</a><br />
<strong>jQuery Browser Plugin</strong> - Updated version included in default package.
<a href="http://jquery.thewikies.com/browser" rel="external">(Original jQuery Browser Plugin)</a>
</p>
<p>
<a href="https://github.com/TurnWheel/jReject" rel="external">Get Latest At GitHub</a>
</p>
<p>
If you are a developer familiar with using jQuery, continue with the documentation below...
</p>
<h2>Documentation</h2>
<div id="documentation">
<p>
The object is called "reject", and can be invoked once the document is ready ($.reject() or jQuery.reject()).
The first parameter contains all the options and configurations for the plugin.
</p>
<h3>Default Options</h3>
<p>
Here are the default options for the first parameter of the reject object. You only need to specify those which
you wish to override.
</p>
<pre name="code" class="javascript" id="options">
options = {
reject : { // Rejection flags for specific browsers
all: false, // Covers Everything (Nothing blocked)
msie5: true, msie6: true // Covers MSIE 5-6 (Blocked by default)
/*
* Possibilities are endless...
*
* // MSIE Flags (Global, 5-8)
* msie, msie5, msie6, msie7, msie8,
* // Firefox Flags (Global, 1-3)
* firefox, firefox1, firefox2, firefox3,
* // Konqueror Flags (Global, 1-3)
* konqueror, konqueror1, konqueror2, konqueror3,
* // Chrome Flags (Global, 1-4)
* chrome, chrome1, chrome2, chrome3, chrome4,
* // Safari Flags (Global, 1-4)
* safari, safari2, safari3, safari4,
* // Opera Flags (Global, 7-10)
* opera, opera7, opera8, opera9, opera10,
* // Rendering Engines (Gecko, Webkit, Trident, KHTML, Presto)
* gecko, webkit, trident, khtml, presto,
* // Operating Systems (Win, Mac, Linux, Solaris, iPhone)
* win, mac, linux, solaris, iphone,
* unknown // Unknown covers everything else
*/
},
display: [], // What browsers to display and their order (default set below)
browserShow: true, // Should the browser options be shown?
browserInfo: { // Settings for which browsers to display
firefox: {
text: 'Firefox 8', // Text below the icon
url: 'http://www.mozilla.com/firefox/' // URL For icon/text link
},
safari: {
text: 'Safari 5',
url: 'http://www.apple.com/safari/download/'
},
opera: {
text: 'Opera 11',
url: 'http://www.opera.com/download/'
},
chrome: {
text: 'Chrome 15',
url: 'http://www.google.com/chrome/'
},
msie: {
text: 'Internet Explorer 9',
url: 'http://www.microsoft.com/windows/Internet-explorer/'
},
gcf: {
text: 'Google Chrome Frame',
url: 'http://code.google.com/chrome/chromeframe/',
// This browser option will only be displayed for MSIE
allow: { all: false, msie: true }
}
},
// Header of pop-up window
header: 'Did you know that your Internet Browser is out of date?',
// Paragraph 1
paragraph1: 'Your browser is out of date, and may not be compatible with '+
'our website. A list of the most popular web browsers can be '+
'found below.',
// Paragraph 2
paragraph2: 'Just click on the icons to get to the download page',
close: true, // Allow closing of window
// Message displayed below closing link
closeMessage: 'By closing this window you acknowledge that your experience '+
'on this website may be degraded',
closeLink: 'Close This Window', // Text for closing link
closeURL: '#', // Close URL
closeESC: true, // Allow closing of window with esc key
// If cookies should be used to remmember if the window was closed
// See cookieSettings for more options
closeCookie: false,
// Cookie settings are only used if closeCookie is true
cookieSettings: {
// Path for the cookie to be saved on
// Should be root domain in most cases
path: '/',
// Expiration Date (in seconds)
// 0 (default) means it ends with the current session
expires: 0
},
imagePath: './images/', // Path where images are located
overlayBgColor: '#000', // Background color for overlay
overlayOpacity: 0.8, // Background transparency (0-1)
// Fade in time on open ('slow','medium','fast' or integer in ms)
fadeInTime: 'fast',
// Fade out time on close ('slow','medium','fast' or integer in ms)
fadeOutTime: 'fast',
// Google Analytics Link Tracking (Optional)
// Set to true to enable
// Note: Analytics tracking code must be added separately
analytics: false
};
</pre>
</div><br />
<h3>Optional Event Methods</h3>
<strong>options.beforeReject()</strong><br />
<p>Called before rejection is determined.</p><br />
<strong>options.afterReject()</strong><br />
<p>Called after rejection window has been created, for browsers that matched the rejection settings.</p><br />
<strong>options.onFail()</strong><br />
<p>Called if the browser does NOT meet the rejection requirements</p><br />
<strong>options.beforeClose()</strong><br />
<p>Called after close button is clicked, but before popup is actually closed.</p><br />
<strong>options.afterClose()</strong><br />
<p>Called after rejection popup is closed</p><br />
<p>
<strong>Note:</strong> All callbacks can access and edit options by using <em>this</em><br />
View <a href="#demo8">Demo #8</a> as an example
</p>
<h2>Browser Plugin Options</h2>
<script type="text/javascript">
$(function() {
$('#b_className').text($.browser.className);
$('#b_name').text($.browser.name);
$('#b_version').text($.browser.version);
$('#b_versionX').text($.browser.versionX);
$('#b_osname').text($.os.name);
});
</script>
$.browser.className = <strong id="b_className"></strong><br />
$.browser.name = <strong id="b_name"></strong><br />
$,browser.version = <strong id="b_version"></strong><br />
$.browser.versionX = <strong id="b_versionX"></strong><br />
$.os.name = <strong id="b_osname"></strong><br />
<h2>Example Usage</h2>
<div class="example">
<h3>Default Settings</h3>
<a href="#" id="demo1" class="demo">Run Demo</a><br />
<p>
If nothing happened when you ran this demo, that is because you are not using IE6!.
By default (no settings specified) the reject function only rejects IE5 and IE6.
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo1').click(function() {
$.reject(); // Default Settings
return false;
});
</pre>
</div>
<div class="example">
<h3>Customize Browsers To Reject</h3>
<a href="#" id="demo2" class="demo">Run Demo</a><br />
<p>
In this example pretty much every browser should be rejected.
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo2').click(function() {
$.reject({
reject: {
safari: true, // Apple Safari
chrome: true, // Google Chrome
firefox: true, // Mozilla Firefox
msie: true, // Microsoft Internet Explorer
opera: true, // Opera
konqueror: true, // Konqueror (Linux)
unknown: true // Everything else
}
}); // Customized Browsers
return false;
});
</pre>
</div>
<div class="example">
<h3>Customize Popup Text</h3>
<a href="#" id="demo3" class="demo">Run Demo</a><br />
<p>
In this demo we use customized text in the popup window.
This demo uses the following properties:<br />
<em class="option">header</em>,
<em class="option">paragraph1</em>,
<em class="option">paragraph2</em>,
<em class="option">closeMessage</em><br />
<strong>See Also</strong> <em class="option">closeLink</em>
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo3').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
header: 'Your browser is not supported here', // Header Text
paragraph1: 'You are currently using an unsupported browser', // Paragraph 1
paragraph2: 'Please install one of the many optional browsers below to proceed', // Paragraph 2
closeMessage: 'Close this window at your own demise!' // Message below close window link
}); // Customized Text
return false;
});
</pre>
</div>
<div class="example">
<h3>Customize Browsers To Suggest</h3>
<a href="#" id="demo4" class="demo">Run Demo</a><br />
<p>
Using the <em class="option">display</em> option, you can define
which browsers to suggest, and the order in which to suggest them.<br />
<acronym title="Google Chrome Frame">GCF</acronym> is supported,
but only displayed for IE users by default.
</p>
<p>
<strong>Default:</strong> ['firefox','chrome','msie','safari','opera','gcf']
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo4').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
display: ['firefox','chrome','opera'] // Displays only firefox, chrome, and opera
});
return false;
});
</pre>
</div>
<div class="example">
<h3>Customize Your Own Browser Suggestion</h3>
<a href="#" id="demo5" class="demo">Run Demo</a><br />
<p>
You can even add a customized browser to the list, and display it in any order you want.
</p>
<p>
<strong>Note:</strong> To add your own icon, you need to create a 'browser_{browserName}.gif'
file and place it in your <em class="option">imagePath</em> directory with the other images.<br />
<strong>Image Dimensions:</strong> 100x100<br />
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo5').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
// Displays only custom "Konqueror" browser, firefox and opera.
display: ['konqueror','firefox','opera'],
browserInfo: {
konqueror: { // Specifies browser name and image name (browser_konqueror.gif)
text: 'Konqueror 4', // Text Link
url: 'http://konqueror.kde.org/' // URL To link to
}
}
});
return false;
});
</pre>
</div>
<div class="example">
<h3>Display Once Per Session</h3>
<a href="#" id="demo6" class="demo">Run Demo</a><br />
<p>
By using the <em class="option">closeCookie</em> option, you can make the window only appear once per session.<br />
After it pops up the first time, this demo will not popup again until next browser session.
</p>
<p>
<strong>Note:</strong> This requires the ability to close the window.
If <em class="option">close</em> is false the cookie will never be set.
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo6').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
closeCookie: true // Set cookie to remmember close for this session
});
return false;
});
</pre>
</div>
<div class="example">
<h3>Disable ability to close window</h3>
<a href="#" id="demo7" class="demo">Run Demo</a><br />
<p>
The <em class="option">close</em> option allows you to hide the <em class="option">closeLink</em> or <em class="option">closeMessage</em> elements from displaying.<br />
This prevents the user from closing the window. If you use this on a onLoad event, the user will never be able to use your site.
</p>
<p>
<strong>Note:</strong> Testing this demo will require you to refresh the page to close out the popup window.
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo7').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
close: false, // Prevent closing of window
paragraph1: 'You will not be able to close this window', // Warning about closing
paragraph2: 'To exit, you must <a href="javascript:window.location=window.location.pathname;">refresh the page</a>' // Display refresh link
});
return false;
});
</pre>
</div>
<div class="example">
<h3>Customize by Browser</h3>
<a href="#" id="demo8" class="demo">Run Demo</a><br />
<p>
This example uses the <em>beforeReject</em> callback to change options by browser.<br />
In chrome, only FireFox and Opera options will be displayed. iPhone/iPad displays no browser options
</p>
<h4>Example Code</h4>
<pre name="code" class="javascript">
$('#demo8').click(function() {
$.reject({
reject: { all: true }, // Reject all renderers for demo
beforeReject: function() {
if ($.browser.name === 'chrome') {
this.display = ['firefox','opera'];
}
if ($.os.name === 'iphone' || $.os.name === 'ipad') {
this.browserShow = false;
this.paragraph2 = '';
}
}
});
return false;
});
</pre>
</div>
</div>
<div id="copyright">
Concept based on <a href="http://code.google.com/p/ie6-upgrade-warning/" rel="external">"IE6 Upgrade Warning"</a><br />
Coded and Implemented by Steven Bower<br />
© 2009-2011 <a href="http://turnwheel.com/" rel="external">TurnWheel Designs</a>
</div>
</body>
</html>