deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-01 05:23:02 +02:00
Code Issues Releases Wiki Activity

Merge pull request #266 from koalyptus/issue-264-doco

Browse source 
Issue 264 doco
This commit is contained in:
koalyptus 2016-07-30 18:10:47 +10:00 committed by GitHub
parent 7616498fa6 5e316bc778
commit c11674178e
17 changed files with 162 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
dist/starter.html vendored
View file

@ -1,10 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>tablefilter v0.2.46 - Starter</title>
<title>tablefilter v0.2.47 - Starter</title>
</head>
<body>
<h1>tablefilter v0.2.46</h1>
<h1>tablefilter v0.2.47</h1>

4
dist/tablefilter/style/colsVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
span.colVisSpan{text-align:left;}span.colVisSpan a.colVis{display:inline-block;padding:7px 5px 0;font-size:inherit;font-weight:inherit;vertical-align:top}div.colVisCont{position:relative;background:#fff;-webkit-box-shadow:3px 3px 2px #888;-moz-box-shadow:3px 3px 2px #888;box-shadow:3px 3px 2px #888;position:absolute;display:none;border:1px solid #ccc;height:auto;width:250px;background-color:#fff;margin:35px 0 0 -100px;z-index:10000;padding:10px 10px 10px 10px;text-align:left;font-size:12px;}div.colVisCont:after,div.colVisCont:before{bottom:100%;left:50%;border:solid transparent;content:" ";height:0;width:0;position:absolute;pointer-events:none}div.colVisCont:after{border-color:rgba(255,255,255,0);border-bottom-color:#fff;border-width:10px;margin-left:-10px}div.colVisCont:before{border-color:rgba(255,255,255,0);border-bottom-color:#ccc;border-width:12px;margin-left:-12px}div.colVisCont p{margin:6px auto 6px auto}div.colVisCont a.colVis{display:initial;font-weight:inherit}ul.cols_checklist{padding:0;margin:0;list-style:none;}ul.cols_checklist label{display:block}ul.cols_checklist input{vertical-align:middle;margin:2px 5px 2px 1px}li.cols_checklist_item{padding:4px;margin:0;}li.cols_checklist_item:hover{background-color:#335ea8;color:#fff}.cols_checklist_slc_item{background-color:#335ea8;color:#fff}

4
dist/tablefilter/style/filtersVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
span.expClpFlt a.btnExpClpFlt{width:35px;height:35px;display:inline-block;}span.expClpFlt a.btnExpClpFlt:hover{background-color:#f4f4f4}span.expClpFlt img{padding:8px 11px 11px 11px}

4
dist/tablefilter/style/tablefilter.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
.activeHeader{background-color:#66afe9 !important;color:#fff !important}

4
dist/tablefilter/style/themes/default/default.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
table.TF{border-left:1px solid #ccc;border-top:none;border-right:none;border-bottom:none;}table.TF th{background:#ebecee url("images/bg_th.jpg") left top repeat-x;border-bottom:1px solid #d0d0d0;border-right:1px solid #d0d0d0;border-left:1px solid #fff;border-top:1px solid #fff;color:#333}table.TF td{border-bottom:1px dotted #999;padding:5px}.fltrow{background-color:#ebecee !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #666 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #999 !important}input.flt{width:99% !important}.inf{height:$min-height;background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important}input.reset{background:transparent url("images/btn_eraser.gif") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;}.nextPage:hover{background:transparent url("images/btn_over_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important;}.previousPage:hover{background:transparent url("images/btn_over_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;}.firstPage:hover{background:transparent url("images/btn_over_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;}.lastPage:hover{background:transparent url("images/btn_over_last_page.gif") center center no-repeat !important}div.grd_Cont{background-color:#ebecee !important;border:1px solid #ccc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#d5d5d5}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important;}div.grd_headTblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#ebecee url("images/bg_th.jpg") left top repeat-x !important;border-bottom:1px solid #d0d0d0 !important;border-right:1px solid #d0d0d0 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #999 !important}.grd_inf{background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important;border-top:1px solid #d0d0d0 !important}.loader{border:1px solid #999}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#fff}.odd{background-color:#d5d5d5}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#999 !important}

4
dist/tablefilter/style/themes/mytheme/mytheme.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
table.TF{border-left:1px dotted #81963b;border-top:none;border-right:0;border-bottom:none;}table.TF th{background:#39424b url("images/bg_headers.jpg") left top repeat-x;border-bottom:0;border-right:1px dotted #d0d0d0;border-left:0;border-top:0;color:#fff}table.TF td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b;padding:5px}.fltrow{background-color:#81963b !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #687830 !important}input.flt{width:99% !important}.inf{background:#d8d8d8;height:$min-height}input.reset{width:53px;background:transparent url("images/btn_filter.png") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important}div.grd_Cont{background:#81963b url("images/bg_headers.jpg") left top repeat-x !important;border:1px solid #ccc !important;padding:0 1px 1px 1px !important;}div.grd_Cont .even{background-color:#bccd83}div.grd_Cont .odd{background-color:#fff}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important;}div.grd_tblCont table td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b}div.grd_tblCont table th,div.grd_headTblCont table th{background:transparent url("images/bg_headers.jpg") 0 0 repeat-x !important;border-bottom:0 !important;border-right:1px dotted #d0d0d0 !important;border-left:0 !important;border-top:0 !important;padding:0 4px 0 4px !important;color:#fff !important;height:35px !important}div.grd_headTblCont table td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;background-color:#81963b !important;padding:1px 3px 1px 3px !important}.grd_inf{background-color:#d8d8d8;border-top:1px solid #d0d0d0 !important}.loader{border:0 !important;background:#81963b !important}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#bccd83}.odd{background-color:#fff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#81963b !important}

4
dist/tablefilter/style/themes/skyblue/skyblue.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.293Z
* MIT License
*/
table.TF{padding:0;color:#000;border-right:1px solid #a4bed4;border-top:1px solid #a4bed4;border-left:1px solid #a4bed4;border-bottom:0;}table.TF th{margin:0;color:inherit;background:#d1e5fe url("images/bg_skyblue.gif") 0 0 repeat-x;border-color:#fdfdfd #a4bed4 #a4bed4 #fdfdfd;border-width:1px;border-style:solid}table.TF td{margin:0;padding:5px;color:inherit;border-bottom:1px solid #a4bed4;border-left:0;border-top:0;border-right:0}.fltrow{background-color:#d1e5fe !important;}.fltrow th,.fltrow td{padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #a4bed4 !important}input.flt{width:99% !important}.inf{background-color:#e3efff !important;border:1px solid #a4bed4;height:$min-height;color:#004a6f}div.tot,div.status{border-right:0 !important}.helpBtn:hover{background-color:transparent}input.reset{background:transparent url("images/icn_clear_filters.png") center center no-repeat !important}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.nextPage:hover{background:#ffe4ab url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.previousPage{background:transparent url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.previousPage:hover{background:#ffe4ab url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.firstPage:hover{background:#ffe4ab url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.lastPage:hover{background:#ffe4ab url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.activeHeader{background:#ffe4ab !important;border:1px solid #ffb552 !important;color:inherit !important}div.grd_Cont{background-color:#d9eaed !important;border:1px solid #9cc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#e3efff}div.grd_headTblCont{background-color:#d9eaed !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#d9eaed url("images/bg_skyblue.gif") left top repeat-x;border-bottom:1px solid #a4bed4;border-right:1px solid #a4bed4 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #a4bed4 !important;border-right:0 !important;border-left:0 !important;border-top:0 !important}.grd_inf{background-color:#cce2fe;color:#004a6f;border-top:1px solid #9cc !important;}.grd_inf a{text-decoration:none;font-weight:bold}.loader{background-color:#2d8eef;border:1px solid #cce2fe;border-radius:5px}.even{background-color:#fff}.odd{background-color:#e3efff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.ezActiveRow{background-color:#ffdc61 !important;color:inherit}.ezSelectedRow{background-color:#ffe4ab !important;color:inherit}.ezActiveCell{background-color:#fff !important;color:#000 !important;font-weight:bold}.ezETSelectedCell{background-color:#fff !important;font-weight:bold;color:#000 !important}

10
dist/tablefilter/tablefilter.js vendored
View file

File diff suppressed because one or more lines are too long

4
dist/tablefilter/tf-1.js vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.644Z
* tablefilter v0.2.47 by Max Guglielmi
* build date: 2016-07-30T07:53:42.279Z
* MIT License
*/

2
package.json
View file

@ -1,6 +1,6 @@
{
"name": "tablefilter",
"version": "0.2.46",
"version": "0.2.47",
"description": "A Javascript library making HTML tables filterable and a bit more",
"license": "MIT",
"author": {

4
src/helpers.js
View file

@ -9,10 +9,6 @@
* @return {String} Unformatted number
*/
export const removeNbFormat = (data, format = 'us') => {
if (!data) {
return;
}
let n = data;
if (format.toLowerCase() === 'us') {
n = + n.replace(/[^\d\.-]/g, '');

2
src/modules/loader.js
View file

@ -29,7 +29,7 @@ export class Loader extends Feature {
*/
this.targetId = f.loader_target_id || null;
/**
/**
* Loader container DOM element
* @type {DOMElement}
*/

122
src/modules/noResults.js
View file

@ -3,11 +3,17 @@ import {createElm, elm, removeElm} from '../dom';
import {isEmpty, isFn} from '../types';
import {NONE} from '../const';
/**
* UI when filtering yields no matches
* @export
* @class NoResults
* @extends {Feature}
*/
export class NoResults extends Feature {
/**
* No results message UI component
* @param {Object} tf TableFilter instance
* Creates an instance of NoResults
* @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'noResults');
@ -15,31 +21,83 @@ export class NoResults extends Feature {
//configuration object
let f = this.config.no_results_message;
/**
* Text (accepts HTML)
* @type {String}
*/
this.content = f.content || 'No results';
/**
* Custom container DOM element
* @type {DOMElement}
*/
this.customContainer = f.custom_container || null;
/**
* ID of custom container element
* @type {String}
*/
this.customContainerId = f.custom_container_id || null;
/**
* Indicates if UI is contained in a external element
* @type {Boolean}
* @private
*/
this.isExternal = !isEmpty(this.customContainer) ||
!isEmpty(this.customContainerId);
/**
* Css class assigned to container element
* @type {String}
*/
this.cssClass = f.css_class || 'no-results';
/**
* Stores container DOM element
* @type {DOMElement}
*/
this.cont = null;
//callback before message is displayed
this.onBeforeShowMsg = isFn(f.on_before_show_msg) ?
/**
* Callback fired before the message is displayed
* @type {Function}
*/
this.onBeforeShow = isFn(f.on_before_show_msg) ?
f.on_before_show_msg : null;
//callback after message is displayed
this.onAfterShowMsg = isFn(f.on_after_show_msg) ?
/**
* Callback fired after the message is displayed
* @type {Function}
*/
this.onAfterShow = isFn(f.on_after_show_msg) ?
f.on_after_show_msg : null;
//callback before message is hidden
this.onBeforeHideMsg = isFn(f.on_before_hide_msg) ?
/**
* Callback fired before the message is hidden
* @type {Function}
*/
this.onBeforeHide = isFn(f.on_before_hide_msg) ?
f.on_before_hide_msg : null;
//callback after message is hidden
this.onAfterHideMsg = isFn(f.on_after_hide_msg) ?
/**
* Callback fired after the message is hidden
* @type {Function}
*/
this.onAfterHide = isFn(f.on_after_hide_msg) ?
f.on_after_hide_msg : null;
this.prfxNoResults = 'nores_';
/**
* Prefix for container ID
* @type {String}
* @private
*/
this.prfx = 'nores_';
}
/**
* Initializes NoResults instance
*/
init() {
if (this.initialized) {
return;
@ -49,7 +107,7 @@ export class NoResults extends Feature {
tf.tbl;
//container
let cont = createElm('div', ['id', this.prfxNoResults + tf.id]);
let cont = createElm('div', ['id', this.prfx + tf.id]);
cont.className = this.cssClass;
cont.innerHTML = this.content;
@ -64,10 +122,17 @@ export class NoResults extends Feature {
// subscribe to after-filtering event
this.emitter.on(['after-filtering'], () => this.toggle());
/**
* @inherited
*/
this.initialized = true;
this.hide();
}
/**
* Toggle no results message
*/
toggle() {
if (this.tf.getValidRowsNb() > 0) {
this.hide();
@ -76,39 +141,49 @@ export class NoResults extends Feature {
}
}
/**
* Show no results message
*/
show() {
if (!this.initialized || !this.isEnabled()) {
return;
}
if (this.onBeforeShowMsg) {
this.onBeforeShowMsg.call(null, this.tf, this);
if (this.onBeforeShow) {
this.onBeforeShow.call(null, this.tf, this);
}
this.setWidth();
this.cont.style.display = 'block';
if (this.onAfterShowMsg) {
this.onAfterShowMsg.call(null, this.tf, this);
if (this.onAfterShow) {
this.onAfterShow.call(null, this.tf, this);
}
}
/**
* Hide no results message
*/
hide() {
if (!this.initialized || !this.isEnabled()) {
return;
}
if (this.onBeforeHideMsg) {
this.onBeforeHideMsg.call(null, this.tf, this);
if (this.onBeforeHide) {
this.onBeforeHide.call(null, this.tf, this);
}
this.cont.style.display = NONE;
if (this.onBeforeHideMsg) {
this.onBeforeHideMsg.call(null, this.tf, this);
if (this.onAfterHide) {
this.onAfterHide.call(null, this.tf, this);
}
}
/**
* Sets no results container width
* @private
*/
setWidth() {
if (!this.initialized || this.isExternal || !this.isEnabled()) {
return;
@ -117,11 +192,14 @@ export class NoResults extends Feature {
let gridLayout = this.tf.feature('gridLayout');
this.cont.style.width = gridLayout.tblCont.clientWidth + 'px';
} else {
this.cont.style.width = this.tf.tbl.clientWidth + 'px';
this.cont.style.width =
this.tf.tbl.tBodies[0].clientWidth + 'px';
}
}
/**
* Remove feature
*/
destroy() {
if (!this.initialized) {
return;

5
src/tablefilter.js
View file

@ -1351,7 +1351,10 @@ export class TableFilter {
// fallback to unformatted number string comparison
if (numCellData && this.hasColNbFormat &&
this.colNbFormat[j] && !this.singleSearchFlt) {
sA = removeNbFormat(sA, nbFormat);
// removeNbFormat can return 0 for strings which are not
// formatted numbers, in that case return the original
// string. TODO: handle this in removeNbFormat
sA = removeNbFormat(sA, nbFormat) || sA;
occurence = numCellData === sA ||
contains(sA.toString(), numCellData.toString(),
this.isExactMatch(j), this.caseSensitive);

4
test/test-filtering.html
View file

@ -16,6 +16,7 @@
<th>c</th>
<th>d</th>
<th>e</th>
<th>f</th>
</tr>
<tr>
<td>21.1.18</td>
@ -23,6 +24,7 @@
<td>3-Jan-2014</td>
<td>alpha a xyz</td>
<td>numeric</td>
<td>2767</td>
</tr>
<tr>
<td>21.1.16</td>
@ -30,6 +32,7 @@
<td>23-Oct-2007</td>
<td>alpha c xyz</td>
<td>numeric 1</td>
<td>0.6565765</td>
</tr>
<tr>
<td>34.234</td>
@ -37,6 +40,7 @@
<td>14-Mar-2009</td>
<td>alpha e xyz</td>
<td>numeric 2</td>
<td>this is a string</td>
</tr>
</table>

31
test/test-filtering.js
View file

@ -1,6 +1,13 @@
var tf = new TableFilter('demo', {
base_path: '../dist/tablefilter/',
col_date_type: [null, null, 'ddmmmyyyy']
col_date_type: [
null, null, 'ddmmmyyyy',
null, null, null
],
col_number_format: [
null, null, null,
null, null, 'US'
]
});
tf.init();
@ -73,6 +80,28 @@ test('can filter columns with alpha numeric values (2)', function(){
tf.filter();
deepEqual(tf.getValidRows().length, 3, 'Expected number of matches');
});
test('can filter numeric value (6)', function(){
// setup
tf.clearFilters();
// act
tf.setFilterValue(5, 2767);
tf.filter();
// assert
deepEqual(tf.getFilteredDataCol(5), ['2767'], 'Expected match');
});
test('Should return no results for an unmatched term (6)', function(){
// setup
tf.clearFilters();
// act
tf.setFilterValue(5, 'hello world');
tf.filter();
// assert
deepEqual(tf.getValidRows().length, 0, 'No matches');
});
module('Tear-down');
test('can destroy TableFilter DOM elements', function() {

2
test/test-no-results-message.js
View file

@ -209,7 +209,7 @@ test('External container sanity checks', function() {
test(type, function() {
deepEqual(tfCall instanceof TableFilter, true,
'First argument type');
deepEqual(typeof noResultsCall.onBeforeShowMsg, 'function',
deepEqual(typeof noResultsCall.onBeforeShow, 'function',
'Second argument type');
});
}