forked from i-like-robots/jQuery-Modal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
265 lines (229 loc) · 10.5 KB
/
index.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge;chrome=1" />
<title>jQuery Modal</title>
<link rel="stylesheet" href="css/example.css" />
<link rel="stylesheet" href="css/pygments.css" />
<link rel="stylesheet" href="css/modal.css" />
<!--
jQuery Modal by Matt Hinchliffe <http://www.maketea.co.uk>
Find out more at GitHub <http://github.com/i-like-robots/jQuery-Modal>
-->
<!-- Google Analytics tracking code -->
<script>
var _gaq=[['_setAccount','UA-2508361-11'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</head>
<body>
<div id="container">
<section id="introduction">
<h1>jQuery Modal</h1>
<p>
Every front-end developer needs their own <a href="http://github.com/i-like-robots/jQuery-Modal">modal
window</a>. jQuery modal is performant, tested, customisable and easy to integrate. Less than 2.5KB
minified and 1KB gzipped.
</p>
<div id="example">
<p>
<button class="js-open">See an example</button>
</p>
<p id="example-content" style="display:none;">
Rump sausage ham short loin pork. Pig venison boudin bresaola, frankfurter sirloin filet mignon pork shankle
capicola. Leberkas jerky ground round short loin bacon. Capicola strip steak flank meatball pork loin beef
ribs turducken, biltong jowl kielbasa rump shank short ribs. Beef beef ribs filet mignon frankfurter,
prosciutto pork chop chicken ground round short ribs tenderloin sirloin fatback brisket.
</p>
</div>
</section>
<hr />
<section id="setup">
<h2>Setup</h2>
<p>
This isn't a copy and paste plugin, it's just an outline. The plugin is instantiated in the usual
manner and an instances API can be accessed via element data.
</p>
<figure>
<pre class="syntax"><span class="c1">// Create a modal instance.</span>
<span class="kd">var</span> <span class="nx">$m</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="s1">'body'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(),</span>
<span class="c1">// Access an instance API</span>
<span class="nx">api</span> <span class="o">=</span> <span class="nx">$m</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="s1">'modal'</span><span class="p">);</span>
</pre>
</figure>
<p>
You can also 'namespace' plugin instances so that multiple modals can be attached to the same parent.
</p>
<figure>
<pre class="syntax"><span class="kd">var</span> <span class="nx">$m</span> <span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="s1">'body'</span><span class="p">);</span>
<span class="c1">// Attach two modal windows to the same parent</span>
<span class="nx">$m</span><span class="p">.</span><span class="nx">modal</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="s1">'alpha'</span><span class="p">).</span><span class="nx">modal</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="s1">'beta'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">alpha</span> <span class="o">=</span> <span class="nx">$m</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="s1">'modal_alpha'</span><span class="p">);</span>
<span class="kd">var</span> <span class="nx">beta</span> <span class="o">=</span> <span class="nx">$m</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="s1">'modal_beta'</span><span class="p">);</span>
</pre>
</figure>
<p>
The simplest example is to open a modal window instance with basic HTML content:
</p>
<figure>
<pre class="syntax"><span class="c1">// Open the modal with some content</span>
<span class="nx">api</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="s2">"<p>Hello, is it me you're looking for?"</span><span class="p">);</span>
</pre>
</figure>
<p>
The API is flexible enough to do any common task such as confirmation boxes, displaying images and
external content.
</p>
<figure>
<pre class="syntax"><span class="nx">$</span><span class="p">.</span><span class="nx">ajax</span><span class="p">({</span>
<span class="nx">url</span><span class="o">:</span> <span class="s1">'http://localhost/api?foo=bar'</span><span class="p">,</span>
<span class="nx">success</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">api</span><span class="p">.</span><span class="nx">isOpen</span><span class="p">)</span>
<span class="p">{</span>
<span class="nx">api</span><span class="p">.</span><span class="nx">update</span><span class="p">(</span><span class="nx">data</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span>
<span class="p">{</span>
<span class="nx">api</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="nx">data</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nx">error</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">xhr</span><span class="p">,</span> <span class="nx">error</span><span class="p">)</span>
<span class="p">{</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">error</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">});</span>
</pre>
</figure>
</section>
<hr />
<section id="options">
<h2>Options</h2>
<p>
Global options can be specified via the standard jQuery plugin interface.
</p>
<dl>
<dt>onopen</dt>
<dd>
Callback function to execute after modal window has opened. Default: <code>undefined</code>.
</dd>
<dt>onhide</dt>
<dd>
Callback function to execute after modal window has closed. Default: <code>undefined</code>.
</dd>
<dt>onupdate</dt>
<dd>
Callback function to execute when modal window content is changed. Default: <code>undefined</code>.
</dd>
<dt>fixed</dt>
<dd>
Use CSS <code>fixed</code> positioning for the modal window instead of <code>absolute</code>.
Default: <code>false</code>.
</dd>
<dt>overlay</dt>
<dd>
Create an overlay beneath the modal window and over the target. Default: <code>true</code>.
</dd>
<dt>blur</dt>
<dd>
Close the modal window when overlay is clicked. Default: <code>true</code>.
</dd>
<dt>escape</dt>
<dd>
Close the modal window when the escape key is pressed. Default: <code>true</code>.
</dd>
<dt>width</dt>
<dd>
Predefined width for modal window. Set to <code>auto</code> for the contents automatic flow width.
Default: <code>640</code>.
</dd>
<dt>maxWidth</dt>
<dd>
Set CSS <code>max-width</code> relative to the modal windows parent. Set to <code>none</code> to
set no maximum width. Default: <code>'95%'</code>.
</dd>
<dt>height</dt>
<dd>
Predefined height for modal window. Set to <code>auto</code> for the contents automatic flow height.
Default: <code>480</code>.
</dd>
<dt>maxHeight</dt>
<dd>
Set CSS <code>max-height</code> relative to the modal windows parent. Set to <code>none</code> to
set no maximum height. Default: <code>'95%'</code>.
</dd>
<dt>namespace</dt>
<dd>
Data attribute and event binding namespace. Default: <code>'modal'</code>.
</dd>
</dl>
</section>
<hr />
<section id="api">
<h2>Public methods</h2>
<dl>
<dt>.align()</dt>
<dd>
Repositions the window to the center of the modal window parent.
</dd>
<dt>.open([content][, callback])</dt>
<dd>
Opens the modal window. <var>Content</var> Passed to the <code>.update()</code> method.
<var>Callback</var> A function to call once the window has opened.
</dd>
<dt>.update(content[, callback])</dt>
<dd>
Updates the contents of the modal window. <var>Content</var> Set the content of the modal window
via jQuery's <a href="http://api.jquery.com/html/#html2">.html()</a> method. <var>Callback</var> A
function to call once the window has been updated. The <code>.align()</code> method will be called
if the window is open.
</dd>
<dt>.resize(width, height)</dt>
<dd>
Resizes the modal window content area. <var>Width</var> and <var>Height</var> can be any unit
compatible with the <a href="http://api.jquery.com/category/dimensions/">jQuery Dimensions</a> API.
</dd>
<dt>.hide([callback])</dt>
<dd>
Hides the modal window and removes event listeners. <var>Callback</var> A function to call once the
window has closed.
</dd>
<dt>A note on callbacks:</dt>
<dd>
All callbacks will be called from the scope of the modal instance, so that <code>this</code> will
refer to the modal instance. Callbacks provided as arguments to the public methods above will be
executed in addition to those specified as instance options.
</dd>
</dl>
</section>
</div>
<a href="http://github.com/i-like-robots/jQuery-Modal">
<img style="position:absolute; top:0; right:0; border:0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" />
</a>
<script src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
<script src="src/modal.js"></script>
<script>
$(function()
{
// Create a modal instance.
var $m = $('body').modal(),
// Access an instance API
api = $m.data('modal');
// Bind a click event to copy a hidden elements content into the modal window
$(document).on('click', '.js-open', function()
{
api.open( document.getElementById('example-content').innerHTML );
});
});
</script>
<script>
var _gaq=[['_setAccount','UA-2508361-11'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>