1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-05-10 02:16:40 +02:00

Added comments for doco to HightlightKeyword and Loader

This commit is contained in:
Max Guglielmi 2016-07-27 17:21:30 +10:00
parent c0c0f1925b
commit 2f042e68dd
16 changed files with 148 additions and 71 deletions

4
dist/starter.html vendored
View file

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

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.856Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* 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}

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.856Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* 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}

View file

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

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.856Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* 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}

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.856Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* 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}

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.856Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.660Z
* 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}

File diff suppressed because one or more lines are too long

View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.44 by Max Guglielmi
* build date: 2016-07-23T08:38:30.772Z
* tablefilter v0.2.46 by Max Guglielmi
* build date: 2016-07-27T07:16:59.644Z
* MIT License
*/

View file

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

View file

@ -51,7 +51,7 @@ export class ClearButton extends Feature {
'" ' + 'title="' + this.tooltip + '" />');
/**
* Prefix fot ID of container element
* Prefix for container ID
* @type {String}
* @private
*/

View file

@ -12,7 +12,7 @@ export class GridLayout extends Feature {
/**
* Creates an instance of GridLayout
* @param {Object} tf TableFilter instance
* @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'gridLayout');

View file

@ -121,7 +121,6 @@ export class Help extends Feature {
/**
* Initialise Help instance
* @returns (description)
*/
init() {
if (this.initialized) {

View file

@ -1,21 +1,43 @@
import {createText, createElm, getText} from '../dom';
import {isArray} from '../types';
/**
* Highlight matched keywords upon filtering
*
* @export
* @class HighlightKeyword
*/
export class HighlightKeyword {
/**
* HighlightKeyword, highlight matched keyword
* @param {Object} tf TableFilter instance
* Creates an instance of HighlightKeyword
* @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
let f = tf.config();
//defines css class for highlighting
/**
* Css class for highlighted term
* @type {String}
*/
this.highlightCssClass = f.highlight_css_class || 'keyword';
/**
* TableFilter instance
* @type {TableFilter}
*/
this.tf = tf;
/**
* TableFilter's emitter instance
* @type {Emitter}
*/
this.emitter = tf.emitter;
}
/**
* Initializes HighlightKeyword instance
*/
init() {
this.emitter.on(
['before-filtering', 'destroy'],
@ -29,7 +51,7 @@ export class HighlightKeyword {
}
/**
* highlight occurences of searched term in passed node
* Highlight occurences of searched term in passed node
* @param {Node} node
* @param {String} word Searched term
* @param {String} cssClass Css class name
@ -108,6 +130,9 @@ export class HighlightKeyword {
});
}
/**
* Remove feature
*/
destroy() {
this.emitter.off(
['before-filtering', 'destroy'],

View file

@ -4,38 +4,84 @@ import {isFn} from '../types';
import {root} from '../root';
import {NONE} from '../const';
/**
* Activity indicator
*
* @export
* @class Loader
* @extends {Feature}
*/
export class Loader extends Feature {
/**
* Loading message/spinner
* @param {Object} tf TableFilter instance
* Creates an instance of Loader.
*
* @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'loader');
// TableFilter configuration
let f = this.config;
//id of container element
this.loaderTgtId = f.loader_target_id || null;
//div containing loader
this.loaderDiv = null;
//defines loader text
this.loaderText = f.loader_text || 'Loading...';
//defines loader innerHtml
this.loaderHtml = f.loader_html || null;
//defines css class for loader div
this.loaderCssClass = f.loader_css_class || 'loader';
//delay for hiding loader
this.loaderCloseDelay = 250;
//callback function before loader is displayed
this.onShowLoader = isFn(f.on_show_loader) ? f.on_show_loader : null;
//callback function after loader is closed
this.onHideLoader = isFn(f.on_hide_loader) ? f.on_hide_loader : null;
//loader div
this.prfxLoader = 'load_';
/**
* ID of custom container element
* @type {String}
*/
this.targetId = f.loader_target_id || null;
/**
* Loader container DOM element
* @type {DOMElement}
*/
this.cont = null;
/**
* Text displayed when indicator is visible
* @type {String}
*/
this.text = f.loader_text || 'Loading...';
/**
* Custom HTML injected in Loader's container element
* @type {String}
*/
this.html = f.loader_html || null;
/**
* Css class for Loader's container element
* @type {String}
*/
this.cssClass = f.loader_css_class || 'loader';
/**
* Close delay in milliseconds
* @type {Number}
*/
this.closeDelay = 250;
/**
* Callback fired when loader is displayed
* @type {Function}
*/
this.onShow = isFn(f.on_show_loader) ? f.on_show_loader : null;
/**
* Callback fired when loader is closed
* @type {Function}
*/
this.onHide = isFn(f.on_hide_loader) ? f.on_hide_loader : null;
/**
* Prefix for container ID
* @type {String}
* @private
*/
this.prfx = 'load_';
}
/**
* Initializes Loader instance
*/
init() {
if (this.initialized) {
return;
@ -44,21 +90,21 @@ export class Loader extends Feature {
let tf = this.tf;
let emitter = this.emitter;
let containerDiv = createElm('div', ['id', this.prfxLoader + tf.id]);
containerDiv.className = this.loaderCssClass;
let containerDiv = createElm('div', ['id', this.prfx + tf.id]);
containerDiv.className = this.cssClass;
let targetEl = !this.loaderTgtId ?
tf.tbl.parentNode : elm(this.loaderTgtId);
if (!this.loaderTgtId) {
let targetEl = !this.targetId ?
tf.tbl.parentNode : elm(this.targetId);
if (!this.targetId) {
targetEl.insertBefore(containerDiv, tf.tbl);
} else {
targetEl.appendChild(containerDiv);
}
this.loaderDiv = containerDiv;
if (!this.loaderHtml) {
this.loaderDiv.appendChild(createText(this.loaderText));
this.cont = containerDiv;
if (!this.html) {
this.cont.appendChild(createText(this.text));
} else {
this.loaderDiv.innerHTML = this.loaderHtml;
this.cont.innerHTML = this.html;
}
this.show(NONE);
@ -92,28 +138,35 @@ export class Loader extends Feature {
this.initialized = true;
}
/**
* Shows or hides activity indicator
* @param {String} Two possible values: '' or 'none'
*/
show(p) {
if (!this.isEnabled()) {
return;
}
let displayLoader = () => {
if (!this.loaderDiv) {
if (!this.cont) {
return;
}
if (this.onShowLoader && p !== NONE) {
this.onShowLoader.call(null, this);
if (this.onShow && p !== NONE) {
this.onShow.call(null, this);
}
this.loaderDiv.style.display = p;
if (this.onHideLoader && p === NONE) {
this.onHideLoader.call(null, this);
this.cont.style.display = p;
if (this.onHide && p === NONE) {
this.onHide.call(null, this);
}
};
let t = p === NONE ? this.loaderCloseDelay : 1;
let t = p === NONE ? this.closeDelay : 1;
root.setTimeout(displayLoader, t);
}
/**
* Removes feature
*/
destroy() {
if (!this.initialized) {
return;
@ -121,8 +174,8 @@ export class Loader extends Feature {
let emitter = this.emitter;
removeElm(this.loaderDiv);
this.loaderDiv = null;
removeElm(this.cont);
this.cont = null;
// Unsubscribe to events
emitter.off([

View file

@ -11,7 +11,7 @@ module('Sanity checks');
test('Loader component', function() {
notEqual(loader, null, 'Loader instanciated');
notEqual(
document.getElementById(loader.prfxLoader+tf.id),
document.getElementById(loader.prfx + tf.id),
null,
'Loader DOM container'
);
@ -61,7 +61,7 @@ test('Can check is enabled', function() {
module('Behaviour');
test('Can show loader', function() {
loader.show('');
deepEqual(loader.loaderDiv.style.display, '', 'Loader is displayed');
deepEqual(loader.cont.style.display, '', 'Loader is displayed');
});
module('Tear-down');