mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-06-07 00:12:25 +02:00
Added comments to constants for auto-generated docs
This commit is contained in:
parent
6070d9b52f
commit
794a40a11e
58
src/const.js
58
src/const.js
|
@ -1,28 +1,84 @@
|
||||||
/**
|
/**
|
||||||
* Filter types
|
* Filter types
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Input filter type
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const INPUT = 'input';
|
export const INPUT = 'input';
|
||||||
|
/**
|
||||||
|
* Select filter type
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const SELECT = 'select';
|
export const SELECT = 'select';
|
||||||
|
/**
|
||||||
|
* Multiple select filter type
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const MULTIPLE = 'multiple';
|
export const MULTIPLE = 'multiple';
|
||||||
|
/**
|
||||||
|
* Checklist filter type
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const CHECKLIST = 'checklist';
|
export const CHECKLIST = 'checklist';
|
||||||
|
/**
|
||||||
|
* None filter type
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const NONE = 'none';
|
export const NONE = 'none';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Key codes
|
* Key codes
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enter key code
|
||||||
|
* @type {Number}
|
||||||
|
*/
|
||||||
export const ENTER_KEY = 13;
|
export const ENTER_KEY = 13;
|
||||||
|
/**
|
||||||
|
* Tab key code
|
||||||
|
* @type {Number}
|
||||||
|
*/
|
||||||
export const TAB_KEY = 9;
|
export const TAB_KEY = 9;
|
||||||
|
/**
|
||||||
|
* Escape key code
|
||||||
|
* @type {Number}
|
||||||
|
*/
|
||||||
export const ESC_KEY = 27;
|
export const ESC_KEY = 27;
|
||||||
|
/**
|
||||||
|
* Up arrow key code
|
||||||
|
* @type {Number}
|
||||||
|
*/
|
||||||
export const UP_ARROW_KEY = 38;
|
export const UP_ARROW_KEY = 38;
|
||||||
|
/**
|
||||||
|
* Down arrow key code
|
||||||
|
* @type {Number}
|
||||||
|
*/
|
||||||
export const DOWN_ARROW_KEY = 40;
|
export const DOWN_ARROW_KEY = 40;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* HTML tags
|
* HTML tags
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Header cell tag
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const HEADER_TAG = 'TH';
|
export const HEADER_TAG = 'TH';
|
||||||
|
/**
|
||||||
|
* Cell tag
|
||||||
|
* @type {String}
|
||||||
|
*/
|
||||||
export const CELL_TAG = 'TD';
|
export const CELL_TAG = 'TD';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Numeric values
|
* Default values
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Auto filter delay in milliseconds
|
||||||
|
* @type {Number}
|
||||||
*/
|
*/
|
||||||
export const AUTO_FILTER_DELAY = 750;
|
export const AUTO_FILTER_DELAY = 750;
|
||||||
|
|
Loading…
Reference in a new issue