-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathindex.html
413 lines (352 loc) · 13.2 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
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Conditional Field</title>
<link rel="canonical" href="https://stevenwanderski.github.io/conditional-field" />
<link rel="icon" href="docs/images/favicon.png?v=2" type="image/x-icon" />
<link href="docs/vendor/prism/prism.css" rel="stylesheet" type="text/css">
<link href='https://fonts.googleapis.com/css?family=Work+Sans:400,300,500,600,700,800,900,200,100|Rubik:400,300,500,700|Hind+Vadodara:400,300' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Anonymous+Pro:400,700|PT+Mono|Roboto+Mono:400,100,300,500,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="docs/app.css">
</head>
<body>
<header class="header">
<div class="container">
<nav class="nav">
<div class="container">
<div class="nav--links">
<a class="nav--link" href="#nav-installation">Installation</a>
<a class="nav--link" href="#nav-examples">Examples</a>
<a class="nav--link" href="#nav-options">Options</a>
</div>
<div class="nav--sticky-links">
<a href="https://raw.githubusercontent.com/stevenwanderski/conditional-field/master/dist/conditional-field.min.js" class="nav--sticky-link" download>
<img src="docs/svg/cloud-down.svg" class="svg" /> Download
</a>
</div>
</div>
</nav>
<div class="star"><img src="docs/svg/star.svg" class="svg" /></div>
<h1>Conditional Field</h1>
<p>Javascript component that shows and hides page elements based on form field values</p>
<a href="https://raw.githubusercontent.com/stevenwanderski/conditional-field/master/dist/conditional-field.min.js" class="button" download>
<img src="docs/svg/cloud-down.svg" class="svg" /> Download
</a>
<a href="https://github.com/stevenwanderski/conditional-field" class="button">
<img src="docs/svg/github-character.svg" class="svg" /> View on Github
</a>
</div>
</header>
<div class="container container__body">
<div class="section">
<h2 id="nav-installation">Installation</h2>
<p>This plugin requires <strong>jQuery</strong>. In the HTML page, first include jQuery, then <strong>Conditional Field</strong>. Be sure to place the script tags just before the closing body tag.</p>
<p>Example:</p>
<div class="code">
<div class="code--header">
HTML
</div>
<div class="code--body">
<pre class="language-markup"><code>
<xmp>
<!DOCTYPE html>
<html>
<head>
...
</head>
<body>
...
<script src="/path/to/jquery.js"></script>
<script src="/path/to/conditional-field.js"></script>
</body>
</html>
</xmp>
</code></pre>
</div>
</div>
<p>The script tags can also be placed in the <strong>head</strong> tag. If doing so, all calls to <strong>Conditional Field</strong> must be wrapped in a <code class="language-javascript">$(document).ready()</code> block.</p>
<p>Example:</p>
<div class="code">
<div class="code--header">
Javascript
</div>
<div class="code--body">
<pre class="language-javascript"><code>
$(document).ready(function(){
new ConditionalField({
...
});
});
</code></pre>
</div>
</div>
<div class="section">
<h3>Using Bower</h3>
<p class="language-markup">Run <code>bower install --save conditional-field</code>, then reference the files in the HTML page.</p>
</div>
<div class="section">
<h3>Using NPM</h3>
<p class="language-markup">Run <code>npm install --save conditional-field</code>, then reference the files in the HTML page.</p>
</div>
<div class="section">
<h3>Manual download</h3>
<p>Download <strong>conditional-field.min.js</strong> and place it in your project directory. Then reference the files in the HTML page.</p>
</div>
</div>
<div class="section">
<h2 id="nav-examples">Examples</h2>
<div class="sample sample--select section">
<h3>Select</h3>
<div class="code">
<div class="code--header">
Example
</div>
<div class="code--body">
<div class="form-item">
<label>Select Payment Method:</label>
<select class="select-field">
<option value="credit">Credit Card</option>
<option value="check">Check</option>
</select>
</div>
<div class="credit">
<div class="form-item">
<label>Card Number:</label>
<input type="text" />
</div>
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</div>
</div>
<div class="code">
<div class="code--header">
HTML
</div>
<div class="code--body">
<pre class="language-markup"><code>
<xmp>
<label>Payment Method:</label>
<select class="select-field">
<option value="credit">Credit Card</option>
<option value="check">Check</option>
</select>
<div class="credit">
<label>Card Number:</label>
<input type="text" />
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</xmp>
</code></pre>
</div>
</div>
<div class="code">
<div class="code--header">
Javascript
</div>
<div class="code--body">
<pre><code class="language-javascript">
new ConditionalField({
control: '.select-field',
visibility: {
'credit': '.credit',
'check': '.check'
}
});
</code></pre>
</div>
</div>
</div>
<div class="sample sample--radio section">
<h3>Radio Button</h3>
<div class="code">
<div class="code--header">
Example
</div>
<div class="code--body">
<div class="form-item">
<label>Payment Method:</label>
<label class="label-radio">
<input type="radio" name="payment" value="credit" class="payment-radios" checked/> Credit Card
</label>
<label class="label-radio">
<input type="radio" name="payment" value="check" class="payment-radios" /> Check
</label>
</div>
<div class="credit">
<div class="form-item">
<label>Card Number:</label>
<input type="text" />
</div>
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</div>
</div>
<div class="code">
<div class="code--header">
HTML
</div>
<div class="code--body">
<pre class="language-markup"><code>
<xmp>
<label>Payment Method:</label>
<label class="label-radio">
<input type="radio" name="payment" value="credit" class="payment-radios" checked/> Credit Card
</label>
<label class="label-radio">
<input type="radio" name="payment" value="check" class="payment-radios" /> Check
</label>
<div class="credit">
<label>Card Number:</label>
<input type="text" />
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</xmp>
</code></pre>
</div>
</div>
<div class="code">
<div class="code--header">
Javascript
</div>
<div class="code--body">
<pre><code class="language-javascript">
new ConditionalField({
control: '.payment-radios',
visibility: {
'credit': '.credit',
'check': '.check'
}
});
</code></pre>
</div>
</div>
</div>
<div class="sample sample--checkbox section">
<h3>Checkbox</h3>
<div class="code">
<div class="code--header">
Example
</div>
<div class="code--body">
<div class="form-item">
<label>
<input type="checkbox" class="payment-checkbox"> Pay with Check
</label>
</div>
<div class="credit">
<div class="form-item">
<label>Card Number:</label>
<input type="text" />
</div>
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</div>
</div>
<div class="code">
<div class="code--header">
HTML
</div>
<div class="code--body">
<pre class="language-markup"><code>
<xmp>
<label>
<input type="checkbox" class="payment-checkbox"> Pay with Check
</label>
<div class="credit">
<label>Card Number:</label>
<input type="text" />
</div>
<div class="check">
<label>Check number:</label>
<input type="text" name="check_number" />
</div>
</xmp>
</code></pre>
</div>
</div>
<div class="code">
<div class="code--header">
Javascript
</div>
<div class="code--body">
<pre><code class="language-javascript">
new ConditionalField({
control: '.payment-checkbox',
visibility: {
'off': '.credit',
'on': '.check'
}
});
</code></pre>
</div>
</div>
</div>
</div>
<div class="section">
<h2 id="nav-options">Options</h2>
<table cellpadding="0" cellspacing="0">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td data-label="Name"><code class="language-markup">control</code></td>
<td data-label="Type">string (element selector)</td>
<td data-label="Description">Form element used to determine visibility of connected elements. The value of this element will be used to find the matching value in the <code class="language-markup">visibility</code> option.</td>
</tr>
<tr>
<td data-label="Name"><code class="language-markup">visibility</code></td>
<td data-label="Type">JSON object</td>
<td data-label="Description" class="language-markup">
<p>The keys provided in this object are used to match the value of the <code>control</code> element. When the <code>control</code> value matches a key, the corresponding element will be shown and all other elements provided in this object will be hidden. The provided object must follow this structure:</p>
<pre class="language-javascript"><code>
{
'control-value': 'element-selector'
}
</code></pre>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<footer class="footer">
<div class="footer--row">Designed and coded with ♥</div>
<div class="footer--row"><a href="http://stevenwanderski.com" target="_blank">Steven Wanderski</a> • Chicago, IL</div>
</footer>
<script src="docs/vendor/prism/prism.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.2/jquery.min.js"></script>
<script src="dist/conditional-field.js"></script>
<script src="docs/app.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-36499930-12', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>