-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathdemo.html
More file actions
515 lines (475 loc) · 28.9 KB
/
Copy pathdemo.html
File metadata and controls
515 lines (475 loc) · 28.9 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<title>instaFilta in-page filtering plugin</title>
<link rel="stylesheet" type="text/css" href="demo.css">
</head>
<body>
<header class="header padded-content">
<h1 class="site-title">instaFilta</h1>
<em class="header-description">instaFilta is a fast and highly customizable in-page filtering jQuery plugin.</em>
</header>
<main class="main">
<section class="section">
<div class="padded-content-h">
<h2 class="section-title">Introduction</h2>
</div>
<div class="l-1-2">
<div class="padded-content-h">
<p>Imagine that you are developing a page that has a huge list or table of data that is being generated by the server. Now imagine that you are an end-user that needs to scroll through all that data in order to find what is needed. This is where instaFilta can greatly improve that experience by filtering out unwanted items in real-time as the user types in a text field.<br>That's pretty much it.</p>
<p>Oh, and it has a whole bunch of options available for you to customize that experince to your liking.</p>
</div>
</div>
<div class="box l-1-2">
<p>This demo page is meant to give you a quick idea if instaFilta is the right plugin for your project. Have you already decided? Great! Then you might want to get into the nitty gritty details. You will find everything you need on the instaFilta GitHub page.</p>
<a class="btn btn-prominent" href="https://github.com/chromawoods/instaFilta/" target="_blank">Technical documentation and download</a>
</div>
</section>
<section class="section">
<div class="padded-content-h">
<h2 class="section-title">Table of contents</h2>
<ol>
<li><a href="#s1">A simple example</a></li>
<li><a href="#s2">Target ALL the things!</a></li>
<li><a href="#s3">Character casing and custom target classes</a></li>
<li><a href="#s4">Highlighting matching characters</li>
<li><a href="#s5">Only match the beginning of a word</a></li>
<li><a href="#s6">Using sections of lists</a></li>
<li><a href="#s7">onFilterComplete returns matched hits</a></li>
<li><a href="#s8">Categorize/tag items</a></li>
<li><a href="#s9">Yes, checkboxes!!</a></li>
<li><a href="#s10">All or nothing</a></li>
</ol>
</div>
</section>
<section class="section" id="s1">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">A simple example</h2>
<p>The following shows an example of using instaFilta's default options. You simply apply the instaFilta function on a text field.</p>
<p>Try it out by entering some text in the input field above the target list. The plugin will bind to any elements having the CSS class <em>instafilta-target</em> and it will ignore character casing. As we will see in other examples, all of this can be customized through the plugin's options.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex1">
<fieldset class="controls">
<input type="text" id="ex1f" placeholder="Type here to filter">
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Carbon</span></li>
<li><span class="instafilta-target">Cobalt</span></li>
<li><span class="instafilta-target">Copper</span></li>
<li><span class="instafilta-target">Gallium</span></li>
<li><span class="instafilta-target">Gold</span></li>
<li><span class="instafilta-target">Hafnium</span></li>
<li><span class="instafilta-target">Iridium</span></li>
<li><span class="instafilta-target">Xenon</span></li>
</ul>
</div>
<pre class="box box-code">
$('#my-input-field').instaFilta();</pre>
</div>
</section>
<section class="section" id="s2">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Target ALL the things!</h2>
<p>The plugin will look for <em>any</em> text inside an element having the instafilta-target class. In this example, not only can you filter on these important people's names, you can also filter on the year they were born.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex2">
<fieldset class="controls">
<input type="text" id="ex2f" placeholder="Type here to filter">
</fieldset>
<table>
<thead>
<tr>
<th>Name</th><th>Born</th>
</tr>
</thead>
<tbody>
<tr class="instafilta-target">
<td>Albert Einstein</td>
<td>1879</td>
</tr>
<tr class="instafilta-target">
<td>Marie Curie</td>
<td>1867</td>
</tr>
<tr class="instafilta-target">
<td>Isaac Newton</td>
<td>1643</td>
</tr>
<tr class="instafilta-target">
<td>Henry Cavendish</td>
<td>1731</td>
</tr>
<tr class="instafilta-target">
<td>Edwin Hubble</td>
<td>1889</td>
</tr>
</tbody>
</table>
</div>
<pre class="box box-code">
<tr class="instafilta-target">
<td>Albert Einstein</td>
<td>1879</td>
</tr></pre>
</div>
</section>
<section class="section" id="s3">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Character casing and custom target classes</h2>
<p>In this example, the filtering term must match the character casing of the target elements. The plugin will not match "mars" but it will match "Mars".</p>
<p>Also note that we can use a custom CSS class for our targets, if you need to adhere to naming conventions.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex3">
<fieldset class="controls">
<input type="text" id="ex3f" placeholder="Type here to filter">
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="planet-name">Mercury</span></li>
<li><span class="planet-name">Venus</span></li>
<li><span class="planet-name">Tellus</span></li>
<li><span class="planet-name">Mars</span></li>
<li><span class="planet-name">Jupiter</span></li>
<li><span class="planet-name">Saturn</span></li>
<li><span class="planet-name">Uranus</span></li>
<li><span class="planet-name">Neptune</span></li>
</ul>
</div>
<pre class="box box-code">
$('#my-input-field').instaFilta({
targets: '.planet-name',
caseSensitive: true
});</pre>
</div>
</section>
<section class="section" id="s4">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Highlighting matching characters</h2>
<p>By setting the <em>markMatches</em> option to <em>true</em>, you can highlight the matching text within the matching items in the list. The matching characters will get wrapped in a <em>span</em> element that has the <em>instafilta-match</em> CSS class. You can change this class by setting the <em>matchCssClass</em> option.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex4">
<fieldset class="controls">
<input type="text" id="ex4f" placeholder="Type here to filter">
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Superman</span></li>
<li><span class="instafilta-target">Wonderwoman</span></li>
<li><span class="instafilta-target">Batman</span></li>
<li><span class="instafilta-target">Spiderman</span></li>
<li><span class="instafilta-target">The Hulk</span></li>
<li><span class="instafilta-target">The Green Lantern</span></li>
<li><span class="instafilta-target">Elektra</span></li>
<li><span class="instafilta-target">Ant Man</span></li>
</ul>
</div>
<pre class="box box-code">
$('#my-input-field').instaFilta({
markMatches: true
});</pre>
</div>
</section>
<section class="section" id="s5">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Only match the beginning of a word</h2>
<p>Easy! Just set the <em>beginsWith</em> option to <em>true</em>.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex5">
<fieldset class="controls">
<input type="text" id="ex5f" placeholder="Type here to filter">
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Bald Bull</span></li>
<li><span class="instafilta-target">Soda Popinski</span></li>
<li><span class="instafilta-target">Don Flamenco</span></li>
<li><span class="instafilta-target">Mike</span></li>
</ul>
</div>
<pre class="box box-code">
$('#my-input-field').instaFilta({
beginsWith: true
});</pre>
</div>
</section>
<section class="section" id="s6">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Using sections of lists</h2>
<p>Many times, a large list of data will be grouped in some way. A group will typically contain a heading and perhaps more stuff. This example of animals is grouped by <a href="http://en.wikipedia.org/wiki/Class_(biology)" target="_blank">class</a>, which is the heading for each group.</p>
<p>When filtering such a list, you probably want to hide the entire section, including heading etc. Just set the <em>instafilta-section</em> CSS class on the containing section element. That's it! And, you can of course customize that class name using the <em>sections</em> option.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex6">
<fieldset class="controls">
<input type="text" id="ex6f" placeholder="Type here to filter">
</fieldset>
<div class="instafilta-section">
<span class="example-section-title">Mammals</span>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Bear</span></li>
<li><span class="instafilta-target">Badger</span></li>
<li><span class="instafilta-target">Moose</span></li>
<li><span class="instafilta-target">Hedgehog</span></li>
<li><span class="instafilta-target">Tiger</span></li>
<li><span class="instafilta-target">Orangutan</span></li>
<li><span class="instafilta-target">Wombat</span></li>
<li><span class="instafilta-target">Blue Whale</span></li>
</ul>
</div>
<div class="instafilta-section">
<span class="example-section-title">Reptiles</span>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Snapping Turtle</span></li>
<li><span class="instafilta-target">Nile Crocodile</span></li>
<li><span class="instafilta-target">Tiger Snake</span></li>
<li><span class="instafilta-target">Green Iguana</span></li>
<li><span class="instafilta-target">Alligator</span></li>
<li><span class="instafilta-target">Chameleon</span></li>
<li><span class="instafilta-target">Gekko</span></li>
<li><span class="instafilta-target">Black Mamba</span></li>
</ul>
</div>
<div class="instafilta-section">
<span class="example-section-title">Birds</span>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Ostrich</span></li>
<li><span class="instafilta-target">Atlantic Puffin</span></li>
<li><span class="instafilta-target">Flamingo</span></li>
<li><span class="instafilta-target">Hummingbird</span></li>
<li><span class="instafilta-target">Penguin</span></li>
<li><span class="instafilta-target">Albatross</span></li>
<li><span class="instafilta-target">Toucan</span></li>
<li><span class="instafilta-target">Mandarin Duck</span></li>
</ul>
</div>
</div>
<pre class="box box-code">
<div class="instafilta-section">
<h2>Birds</h2>
<ul class="example-list">
<li><span class="instafilta-target">Ostrich</span></li>
<li><span class="instafilta-target">Atlantic Puffin</span></li>
<li><span class="instafilta-target">Flamingo</span></li>
<li><span class="instafilta-target">Hummingbird</span></li>
<li><span class="instafilta-target">Penguin</span></li>
<li><span class="instafilta-target">Albatross</span></li>
<li><span class="instafilta-target">Toucan</span></li>
<li><span class="instafilta-target">Mandarin Duck</span></li>
</ul>
</div></pre>
</div>
</section>
<section class="section" id="s7">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">onFilterComplete returns matched hits</h2>
<p>After the filtering process is done, you might want to report just how many hits were found and perhaps show some message if no hits were found. This example shows you how.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex7">
<fieldset class="controls">
<input type="text" id="ex7f" placeholder="Type here to filter">
<span class="result-message" id="some-result-message"></span>
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target">Peter</span></li>
<li><span class="instafilta-target">Lois</span></li>
<li><span class="instafilta-target">Stewie</span></li>
<li><span class="instafilta-target">Chris</span></li>
</ul>
<pre class="box box-code">
var $myMessage = $('#some-result-message');
$('#my-input-field').instaFilta({
onFilterComplete: function(matchedItems) {
var message = (matchedItems.length > 0)
? "I found " + matchedItems.length + " matches!"
: "I couldn't find a thing..";
$myMessage.text(message);
}
});</pre>
</div>
</section>
<section class="section" id="s8">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Categorize/tag items</h2>
<p>This is a bit similar to using sections, but it has some important differences. You can tag individual target items with several categories. Do this by defining one or more (comma separated string or array) categories in a data-attribute associated with the <em>categoryDataAttr</em> option. You can then use the <em>filterCategory</em> method to perform filtering based on those categories.</p>
<p>In this example, a select box is used to filter out humans and machines. Note that "RoboCop" exists in both the <em>machine</em> category and the <em>human</em> category.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex8">
<fieldset class="controls">
<input type="text" id="ex8f" placeholder="Type here to filter">
<select id="ex8s">
<option value="">Show all</option>
<option value="machine">Machines</option>
<option value="human">Humans</option>
<option value="non-fictional">Non-fictional</option>
</select>
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target" data-instafilta-category="machine">R2-D2</span></li>
<li><span class="instafilta-target" data-instafilta-category="machine">Terminator</span></li>
<li><span class="instafilta-target" data-instafilta-category="human">John Connor</span></li>
<li><span class="instafilta-target" data-instafilta-category="human,non-fictional">Andreas Larsson</span></li>
<li><span class="instafilta-target" data-instafilta-category="machine">Johnny 5</span></li>
<li><span class="instafilta-target" data-instafilta-category="human">Gordon Freeman</span></li>
<li><span class="instafilta-target" data-instafilta-category="machine">Wall-E</span></li>
<li><span class="instafilta-target" data-instafilta-category="human,machine">RoboCop</span></li>
</ul>
<h3 class="lesser-title">If the HTML looks like this..</h3>
<pre class="box box-code">
<span class="instafilta-target" data-instafilta-category="human">Gordon Freeman</span>
<span class="instafilta-target" data-instafilta-category="machine">Wall-E</span>
<span class="instafilta-target" data-instafilta-category="human,machine,both">RoboCop</span></pre>
<h3 class="lesser-title">..then we can filter it by category like this</h3>
<pre class="box box-code">
var insta = $('#filtering').instaFilta();
/* This will show "Gordon Freeman" and "RoboCop" */
insta.filterCategory('human');
/* This will show "Wall-E" and "RoboCop" */
insta.filterCategory('machine');
/* This will only show "RoboCop" */
insta.filterCategory('both');</pre>
</div>
</section>
<section class="section" id="s9">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">Yes, checkboxes!!</h2>
<p>Given that we can feed several categories to the <em>filterCategories</em> method, we can create an interface that scoops up the values of checked checkboxes and use them for this pupose. Have a go at this example!</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex9">
<fieldset class="controls">
<input type="text" id="ex9f" placeholder="Type here to filter">
<label for="ex9-cat1"><input type="checkbox" id="ex9-cat1" value="europe">Europe</label>
<label for="ex9-cat2"><input type="checkbox" id="ex9-cat2" value="asia">Asia</label>
<label for="ex9-cat3"><input type="checkbox" id="ex9-cat3" value="africa">Africa</label>
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target" data-instafilta-category="europe">Sweden</span></li>
<li><span class="instafilta-target" data-instafilta-category="asia">India</span></li>
<li><span class="instafilta-target" data-instafilta-category="africa">Angola</span></li>
<li><span class="instafilta-target" data-instafilta-category="europe">Germany</span></li>
<li><span class="instafilta-target" data-instafilta-category="asia">Japan</span></li>
<li><span class="instafilta-target" data-instafilta-category="africa">Chad</span></li>
<li><span class="instafilta-target" data-instafilta-category="europe">Belgium</span></li>
<li><span class="instafilta-target" data-instafilta-category="asia">China</span></li>
<li><span class="instafilta-target" data-instafilta-category="africa">Ghana</span></li>
<li><span class="instafilta-target" data-instafilta-category="europe">Finland</span></li>
<li><span class="instafilta-target" data-instafilta-category="asia">Thailand</span></li>
<li><span class="instafilta-target" data-instafilta-category="africa">Kenya</span></li>
<li><span class="instafilta-target" data-instafilta-category="europe">Croatia</span></li>
<li><span class="instafilta-target" data-instafilta-category="asia">Vietnam</span></li>
<li><span class="instafilta-target" data-instafilta-category="africa">Madagascar</span></li>
<li><span class="instafilta-target" data-instafilta-category="europe">Belarus</span></li>
</ul>
<h3 class="lesser-title">The checkboxes look like this..</h3>
<pre class="box box-code">
<input type="checkbox" value="europe"></pre>
<h3 class="lesser-title">..and the JavaScript looks like this:</h3>
<pre class="box box-code">
var instaFilta = $('.continents').instaFilta();
var $myCheckboxes = $('.continent-check');
$myCheckboxes.on('change', function() {
var checkedCategories = [];
$myCheckboxes.each(function() {
if ($(this).prop('checked')) {
checkedCategories.push($(this).val());
}
});
instaFilta.filterCategory(checkedCategories);
});</pre>
</div>
</section>
<section class="section" id="s10">
<div class="l-1-2">
<div class="padded-content-h">
<h2 class="section-title">All or nothing</h2>
<p>When applying multiple categories at once, instaFilta will match <em>any</em> matching categories. In some cases however, like this following example, you want to make sure that items only match if they belong to <em>all</em> categories.</p>
</div>
</div>
<div class="box l-1-2">
<div class="example" id="ex10">
<fieldset class="controls">
<input type="text" id="ex10f" placeholder="Type here to filter">
<label for="ex10-cat1"><input type="checkbox" id="ex10-cat1" value="swims">Swims</label>
<label for="ex10-cat2"><input type="checkbox" id="ex10-cat2" value="walks">Walks</label>
<label for="ex10-cat3"><input type="checkbox" id="ex10-cat3" value="flies">Flies</label>
<label for="ex10-cat4"><input type="checkbox" id="ex10-cat4" value="trots">Trots</label>
</fieldset>
<ul class="example-list example-list-quad">
<li><span class="instafilta-target" data-instafilta-category="walks,flies">Ladybug</span></li>
<li><span class="instafilta-target" data-instafilta-category="walks">Porcupine</span></li>
<li><span class="instafilta-target" data-instafilta-category="swims">Bullshark</span></li>
<li><span class="instafilta-target" data-instafilta-category="swims,walks">Crocodile</span></li>
<li><span class="instafilta-target" data-instafilta-category="walks">Camel</span></li>
<li><span class="instafilta-target" data-instafilta-category="swims,walks">Iguana</span></li>
<li><span class="instafilta-target" data-instafilta-category="swims,walks,flies,trots">Unicorn</span></li>
<li><span class="instafilta-target" data-instafilta-category="swims,flies">Flying Fish</span></li>
</ul>
<h3 class="lesser-title">Example markup</h3>
<pre class="box box-code">
<input type="checkbox" value="walks">
<input type="checkbox" value="flies">
<span class="instafilta-target" data-instafilta-category="walks,flies">Ladybug</span></pre>
<h3 class="lesser-title">Example JavaScript (notice the second parameter, which is set to true)</h3>
<pre class="box box-code">
var instaFilta = $('.animals').instaFilta();
var $myCheckboxes = $('.ability-check');
$myCheckboxes.on('change', function() {
var checkedCategories = [];
$myCheckboxes.each(function() {
if ($(this).prop('checked')) {
checkedCategories.push($(this).val());
}
});
instaFilta.filterCategory(checkedCategories, true);
});</pre>
</div>
</section>
</main>
<a href="https://github.com/chromawoods/instaFilta"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<link href="http://fonts.googleapis.com/css?family=Lily+Script+One" rel="stylesheet" type="text/css">
<link href="http://fonts.googleapis.com/css?family=Roboto:400,300,700" rel="stylesheet" type="text/css">
<script src="instafilta.min.js"></script>
<script src="demo.js"></script>
<footer class="footer padded-content">
Built and designed by <a href="http://chromawoods.com/">Andreas Larsson</a>
</footer>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23289011-1']);
_gaq.push(['_trackPageview']);
(function () {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>