vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-04 17:20:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add the documantation.

Browse Source
This commit is contained in:
hamid_mayeli_geeksltd
2019-04-05 10:45:32 +01:00
parent 2df9fc7774
commit d82151f4e6
1 changed files with 335 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

382
types/jquery-typeahead/index.d.ts vendored
View File

@@ -93,52 +93,250 @@ declare namespace RunningCoder.Typeahead {
* @default false
*/
accent?: boolean | any,
searchOnFocus?: boolean,
debug?: boolean,
backdrop?: boolean | CssObject,
correlativeTemplate?: boolean,
emptyTemplate?: string | ((query?: string) => string | JQuery),
source?: Source | Source[] | SourceTable,
callback?: Callback,
blurOnTab?: boolean,
highlight?: "any" | boolean, // Added "any" to highlight any word in the template, by default true will only highlight display keys
multiselect?: MultiSelectSettings, // Multiselect configuration object, see documentation for all options
group?: boolean | string | GroupSetting, // Improved feature, boolean,string,object(key, template (string, function))
groupOrder?: "asc" | "desc" | string[] | ((node?: JQuery, query?: string, result?: any, resultCount?: number, resultCountPerGroup?: number) => any), // New feature, order groups "asc", "desc", Array, Function
maxItemPerGroup?: number, // Maximum number of result per Group
/**
* The search result(s) will receive the <strong> HTML tag around the matched query.
*
* If set to `true`, only the display keys will be highlighted
*
* If set to `"any"`, any string within the template will be highlighted
*
* @default true
*/
highlight?: "any" | boolean,
/**
* `multiselect` configuration
* */
multiselect?: MultiSelectSettings,
/**
* If set to `true`, the results will grouped by the group name specified inside `source`.
*
* If set to `string`, the results will be grouped by the corresponding object key.
* Ex: group: `"conference"` will group the hockey teams by `"Western"` and `"Eastern"` conferences in [hockey_v1 demo](http://www.runningcoder.org/jquerytypeahead/demo/#form-hockey_v1)
*
* If an Object is set: `key`: Grouping key. `template`: Grouping template in the result list (custom header text), can be string or function.
*
* @default false
*/
group?: boolean | string | GroupSetting,
/**
* By default, the groups will be output in the same order as they are defined in `source`.
* Set `"asc"` or `"desc"` to have the group name sorted ascending or descending
* Set an `Array` to specify the group order to appear in the search result
*/
groupOrder?: "asc" | "desc" | string[] | ((node?: JQuery, query?: string, result?: any, resultCount?: number, resultCountPerGroup?: number) => any),
/** Set a maximum results per group if `group: true` configuration is enabled */
maxItemPerGroup?: number,
/**
* If a string a specified, a dropdown filter will be created between the search input and the search submit button using the `source.group` as indexes.
* The string value will appear at the end of the dropdown and will filter through all the sources.
*
* If an array of objects is set, the dropdownFilter will be built based on it. It is then possible to create filters based on item matching key:value. -
* [Demo](http://www.runningcoder.org/jquerytypeahead/demo/#form-hockey_v1)
*/
dropdownFilter?: boolean | "string" | DropdownFilterItem[], // Take group options string and create a dropdown filter
dynamicFilter?: false | DynamicFilterItem[], // Filter the typeahead results based on dynamic value, Ex: Players based on TeamID
backdropOnFocus?: true, // Display the backdrop option as the Typeahead input is :focused
cache?: boolean | "localStorage" | "sessionStorage", // Improved option, true OR 'localStorage' OR 'sessionStorage'
ttl?: number, // Cache time to live in ms
/**
* If filters objects are defined, the Typeahead source data will be filtered based on the `"selected"` / `"checked"` checkboxes,
* radios and selects based on `"OR"` and `"AND"` filtering similar to database queries.
* * `selector` is the jquery selector to reach the unique input type `"checkbox"`, `"radio"` or select tag
* * `key` the object key that will be filtered, you can use "dot" notation to reach deep object properties,
* but in that case extra processing will be performed. Ex `object.key.is.deep`
* * `|` key prefix means "OR" filtering, the object key CAN match the value
* * `&` key prefix means "AND" filtering, the object key HAS to match the value
*
* Ex `dynamicFilter: [{ selector: "#assassin", key: "|tags.Assassin" }],`
*/
dynamicFilter?: false | DynamicFilterItem[],
/**
* If set to `true`, html will be added to add a backdrop under the search input and results.
* It is possible to override the css options by passing an object to this option.
*/
backdrop?: boolean | CssObject,
/**
* If set to `true`, as soon as the Typeahead input is focused, the `backdrop` option will be displayed regardless.
*/
backdropOnFocus?: true,
/**
* * If set to `true` or `localStorage`, the source data will be stored in `localStorage`.
* * If set to `sessionStorage`, the source data will be stored in `sessionStorage`.
*/
cache?: boolean | "localStorage" | "sessionStorage",
/** This is a `cache` configuration, it sets the storage time to live in milliseconds. */
ttl?: number,
/**
* Enabling this option will compress the data inside Localstorage.
* * Setting `compression: true` requires `cache: true` option to be enabled.
*/
compression?: boolean, // Requires LZString library
resultContainer?: "string" | JQuery | false, // List the results inside any container string or jQuery object
generateOnLoad?: boolean, // Forces the source to be generated on page load even if the input is not focused!
mustSelectItem?: boolean, // The submit function only gets called if an item is selected
href?: string | ((item?: any) => string), // String or Function to format the url for right-click & open in new tab on link results
/**
* If enabled, the typeahead will display results (if any) on input focus. You can combine this option with the input
* attribute `"autofocus"` to display results when the page is loaded.
*/
searchOnFocus?: boolean,
/** Blur Typeahead when Tab key is pressed, if false Tab will go though search results */
blurOnTab?: boolean,
/**
* If a jQuery string selector or jQuery object is specified, the typeahead results will appear in that container instead of the default one.
* If the option is set to `false`, the HTML result list will not be built.
* Use this option for filtering "already on page" HTML list elements with show / hide.
*/
resultContainer?: "string" | false | JQuery,
/**
* If enabled, the source data will be generated (doing Ajax request and preparing to data to be searched)
* on page load instead of waiting for the input to be focused.
* * This option does not work well with `dynamic: true` unless some other configuration is adjusted.
*/
generateOnLoad?: boolean,
/**
* If enabled, an item will HAVE TO be selected in order to submit the form.
* Use this option if you want to restrict searching to your data set only.
*/
mustSelectItem?: boolean,
/**
* If a string is defined, every result item will receive the string as href attribute replacing any `{{itemKey}}` by the `item's value`.
* It is possible to apply an extra operation of `"slugify"` on the value `{{url|slugify}}`. - [Demo](http://www.runningcoder.org/jquerytypeahead/demo/#form-beer_v1)
*/
href?: string | ((item?: any) => string),
/**
* The key that will be searched for typeahead matching results inside source objects.
* It is possible to search through multiple keys by simply adding them inside the configuration array.
*/
display?: string[], // Allows search in multiple item keys ["display1", "display2"]
template?: string | ((query?: string, item?: any) => string), // Display template of each of the result list
templateValue?: string, // Set the input value template when an item is clicked
groupTemplate?: null, // Set a custom template for the groups
cancelButton?: boolean, // If text is detected in the input, a cancel button will be available to reset the input (pressing ESC also cancels)
loadingAnimation?: true, // Display a loading animation when typeahead is doing request / searching for results
filter?: boolean | ((item?: any, displayKey?: string) => boolean), // Set to false or function to bypass Typeahead filtering. WARNING: accent, correlativeTemplate, offset & matcher will not be interpreted
matcher?: ((item?: any, displayKey?: string) => boolean), // Add an extra filtering function after the typeahead functions
/**
* The template is a HTML string containing keys that will replaced by match results object keys.
* You MUST use `{{variable}}` delimiters for your string to be replaced.
*
* You can also reach multi-level deep object properties using regular `"."` format, `{{variable.secordlevel.thirdlevel}}`
*
* If you need to print the item values inside HTML data attributes, it is possible to use `{{variable|raw}}`.
* That optional modifier will make sure to get the unmodified value.
*/
template?: string | ((query?: string, item?: any) => string),
/**
* In case there are no results to be displayed, a row will be displayed containing this template.
* It is possible to display the query using `{{query}}` string.
*/
emptyTemplate?: string | ((query?: string) => string | JQuery),
/**
* When an item is selected / clicked, by default the `"Matched key"` will go inside the input.
* By defining a `templateValue`, the text that will result in the input can be customized.
*/
templateValue?: string,
/**
* This option provides a small `"x"` on the right side of the input to clear the text,
* similar to some browser's default behavior with `input[type="search"]`.
*/
cancelButton?: boolean,
/**
* If set to function, every element will be filtered using this custom rule AFTER the regular Typeahead filters have been applied.
*/
filter?: boolean | ((item?: any, displayKey?: string) => boolean),
/**
* By default, search text matching is reserved to `display` keys. A searched text can't match multiple keys.
*
* If the option is enabled with `true` or `array` of display keys, every item will reveive an additional key called `compiled`.
* This key will then be searched first (using soften matching mechanism) for any matching results, then the `display` keys will
* be searched (using a `"string perfect"` matching mechanism).
*
* If the option is set to true, the `template` option will be compiled into the `"compiled"` item key.
*
* It is also possible to set an Array of display keys instead of the complete template. Try it on
* [Hockey_v1](http://www.runningcoder.org/jquerytypeahead/demo/#form-hockey_v1)
*/
correlativeTemplate?: boolean | any[],
/**
* The source option corresponds to the data set(s) that Typeahead will look through to find matches for the user query string.
* Inside the source, you can have multiple lists of data (groups)
* It is possible to send an async request inside the data function using `$.Deferred`
* `source.group` configuration:
*/
source?: Source | Source[] | SourceTable,
/** Display debug information (RECOMMENDED for dev environment) */
debug?: boolean,
/**
* The callbacks are used to customize and add functionality to your Typeahead instance. You will find plenty of examples in the Demo section.
* There are 3 ways to define the callbacks:
* * Function `(recommended)`: Anonymous function calling a local function with parameters.
* * String: Function name (can be namespaced) located on the window scope without any parameters.
* * Array: First element is the function name accessible from the window scope, second element is an array containing the parameters.
*/
callback?: Callback,
/** Set a custom template for the groups */
groupTemplate?: null,
/** Display a loading animation when typeahead is doing request / searching for results */
loadingAnimation?: true,
/** If set to function, every element will be filtered using this custom rule AFTER the regular Typeahead filters have been applied. */
matcher?: ((item?: any, displayKey?: string) => boolean),
selector?: Selector
}
interface Source {
/** Overrides the default configuration for the specified group. */
minLength?: number,
/** Overrides the default configuration for the specified group. */
maxLength?: false | number,
/** Overrides the default configuration for the specified group. */
dynamic?: boolean,
/** Overrides the default configuration for the specified group. */
filter?: boolean | ((item?: any, displayKey?: string) => boolean),
/** Overrides the default configuration for the specified group. */
matcher?: ((item?: any, displayKey?: string) => boolean),
/** Overrides the default configuration for the specified group. */
cache?: boolean | "localStorage" | "sessionStorage",
/** Overrides the default configuration for the specified group. */
compression?: boolean,
/** Overrides the default configuration for the specified group. */
ttl?: number,
/** Array or function that returns an Array. The items in your array can either be strings or objects */
data?: any[] | (() => any[]),
/** Overrides the default configuration for the specified group. */
template?: string | ((query?: string, item?: any) => string),
/** Overrides the default configuration for the specified group. */
display?: string | string[],
/** En extended version of `JQuery Ajax` */
ajax?: AJaxSettings | ((query?: string) => AJaxSettings)
}
@@ -176,45 +374,135 @@ declare namespace RunningCoder.Typeahead {
}
interface MultiSelectSettings {
/** Optional limit of maximum items to select */
limit?: number,
/** Template when the limit is reached */
limitTemplate?: string | ((query?: string) => any),
/** Unique item identifier to remove an item from the result list when selected (use any of the item key), by default a JSON of the item will be used */
matchOn?: string | any[],
/** If true, the last label will be deleted if the query is empty and backspace is pressed */
cancelOnBackspace?: boolean,
/** Href link on the multiselect item */
href?: string | ((item?: any) => any),
/** Default items when Typeahead is loade */
data?: any[] | (() => any[] | any),
callback?: MultiSelectSettingsCallback
}
interface MultiSelectSettingsCallback {
onClick?: (node?: JQuery, item?: any, event?: JQueryEventObject) => any;
onCancel?: (node?: JQuery, item?: any, event?: JQueryEventObject) => any;
/** Triggered when a multiselect item is clicked */
onClick?: (node?: JQuery, item?: any, event?: JQueryEventObject) => void,
/** Triggered when a multiselect item is canceled */
onCancel?: (node?: JQuery, item?: any, event?: JQueryEventObject) => void,
}
interface Callback {
/** Will be executed on Typeahead initialization, before anything else. */
onInit?: (node?: JQuery) => void,
onNavigateBefore?: (node?: JQuery, query?: string, event?: JQueryEventObject) => void,
onNavigateAfter?: (node?: JQuery, lis?: JQuery, a?: JQuery, item?: any, query?: string, event?: JQueryEventObject) => void,
onClickAfter?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
onResult?: (node?: JQuery, query?: string, result?: any, resultCount?: number) => void,
onMouseEnter?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
onMouseLeave?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
onClick?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
onSubmit?: (node?: JQuery, form?: any, item?: any, event?: JQueryEventObject) => void,
onSendRequest?: (node?: JQuery, query?: string) => void,
onReceiveRequest?: (node?: JQuery, query?: string) => void,
onShowLayout?: (node?: JQuery, query?: string) => void,
onHideLayout?: (node?: JQuery, query?: string) => void,
onLayoutBuiltBefore?: (node?: JQuery, query?: string, result?: any, resultHtmlList?: JQuery) => JQuery,
onPopulateSource?: (node?: JQuery, data?: any[], group?: any, path?: any) => any[],
/** Triggers when the Typeahead initial preparation is completed. */
onReady?: (node?: JQuery) => void, // When the Typeahead initial preparation is completed
/** Triggers when the Typeahead results layout is displayed. */
onShowLayout?: (node?: JQuery, query?: string) => void,
/** Triggers when the Typeahead results layout is requested to hide. */
onHideLayout?: (node?: JQuery, query?: string) => void,
/** Triggers every time a new search is executed in Typeahead. */
onSearch?: (node?: JQuery, query?: string) => void, // When data is being fetched & analyzed to give search results
/** Whenever the result changes, this callback will be triggered. */
onResult?: (node?: JQuery, query?: string, result?: any, resultCount?: number) => void,
/**
* When the result HTML is build, modify it before it get showed.
* This callback should be used to modify the result DOM before it gets inserted into Typeahead.
* * If you are using this callback, the resultHtmlList param needs to be returned at the end of your function.
*/
onLayoutBuiltBefore?: (node?: JQuery, query?: string, result?: any, resultHtmlList?: JQuery) => JQuery,
/** Perform an action right after the result HTML gets inserted into Typeahead's DOM. */
onLayoutBuiltAfter?: (node?: JQuery, query?: string, result?: any) => void, // Modify the dom right after the results gets inserted in the result container
onEnter?: (node?: JQuery, item?: any, result?: any, event?: JQueryEventObject) => void, // When an item in the result list is focused
onLeave?: (node?: JQuery, item?: any, result?: any, event?: JQueryEventObject) => void, // When an item in the result list is blurred
/**
* When a key is pressed to navigate the results. It is possible to disable the input text change
* when using up and down arrows when `event.preventInputChange` is set to true
* */
onNavigateBefore?: (node?: JQuery, query?: string, event?: JQueryEventObject) => void,
/** Called at the end of Navigate (once the `.active` class and other operations are completed). */
onNavigateAfter?: (node?: JQuery, lis?: JQuery, a?: JQuery, item?: any, query?: string, event?: JQueryEventObject) => void,
/** Will be executed when a item is hovered inside the result list. */
onMouseEnter?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
/** Will be executed when a result item is hovered out. */
onMouseLeave?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
/**
* Will be executed when a result item is clicked or the right arrow is pressed when an item is selected from
* the results list. This function will trigger before the regular behaviors.
*/
onClick?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
/**
* Will be executed when a result item is clicked or the right arrow is pressed when an item is selected from
* the results list. This function will trigger before the regular behaviors.
*/
onClickBefore?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void, // Possibility to e.preventDefault() to prevent the Typeahead behaviors
/**
* Will be executed when a result item is clicked or the right arrow is pressed when an item is selected from
* the results list. This function will trigger after the regular behaviors.
*/
onClickAfter?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void,
/** Will be executed when a dropdown filter is selected. Requires `dropdownFilter: true`. */
onDropdownFilter?: (node?: JQuery, a?: JQuery, item?: any, event?: JQueryEventObject) => void, // When the dropdownFilter is changed, trigger this callback
onCacheSave?: (node?: JQuery, data?: any, group?: any, path?: any) => void, // Perform operation on the source data before it gets in Typeahead cache
/** Gets called when the Ajax request(s) are sent. Either on initial requests or on every dynamic requests. */
onSendRequest?: (node?: JQuery, query?: string) => void,
/** Gets called when the Ajax request(s) are all received */
onReceiveRequest?: (node?: JQuery, query?: string) => void,
/**
* Gets called after the Ajax requests are all received and the data is populated inside Typeahead.
* This is the place where extra parsing or filtering should occure before the data gets available inside any Typeahead query
* For example, the Backend sends the "display" key separated by underscores "_" instead of spaces " ".
* * The `data` parameter HAS to be returned after it's transformed.
*/
onPopulateSource?: (node?: JQuery, data?: any[], group?: any, path?: any) => any[],
/** Perform operation on the source data before it gets in Typeahead cache */
onCacheSave?: (node?: JQuery, data?: any, group?: any, path?: any) => void,
/**
* Override the native onSubmit function by your own.
* If after performing a set of action(s) you want to submit the form, simply do `form.submit()`.
* * The item parameter is not always defined. An item object will be sent if the submit happens after an item from the list has been selected.
*/
onSubmit?: (node?: JQuery, form?: any, item?: any, event?: JQueryEventObject) => void,
/**
* Any time there is text inside the input and it gets cleared (Backspace, Esc, Cancel button, etc).
* It is possible to track back the event that cleared the input using event.originalEvent
*/
onCancel?: (node?: JQuery, event?: JQueryEventObject) => void, // Triggered if the typeahead had text inside and is cleared
/** When an item in the result list is focused */
onEnter?: (node?: JQuery, item?: any, result?: any, event?: JQueryEventObject) => void,
/** When an item in the result list is blurred */
onLeave?: (node?: JQuery, item?: any, result?: any, event?: JQueryEventObject) => void,
}
interface Selector {