diff --git a/types/ion-rangeslider/index.d.ts b/types/ion-rangeslider/index.d.ts new file mode 100644 index 0000000000..9788741b77 --- /dev/null +++ b/types/ion-rangeslider/index.d.ts @@ -0,0 +1,81 @@ +// Type definitions for ion-rangeslider 2.2 +// Project: https://github.com/IonDen/ion.rangeSlider/ +// Definitions by: Karel van de Plassche +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +// API documentation: http://ionden.com/a/plugins/ion.rangeSlider/en.html +// Parsed using https://github.com/Karel-van-de-Plassche/ion-rangeslider-parser.git +// Based on global-modifying module template file + +declare global { + interface JQuery { + destroy(): void; + ionRangeSlider(options?: IonRangeSliderOptions): JQuery; + reset(): void; + update(option: IonRangeSliderOptions): void; + } +} + +export interface IonRangeSliderOptions { + type?: string; // Choose slider type, could be `single` - for one handle, or `double` for two handles [Default: single] + min?: number; // Set slider minimum value [Default: 10] + max?: number; // Set slider maximum value [Default: 100] + from?: number; // Set start position for left handle (or for single handle) [Default: min] + to?: number; // Set start position for right handle [Default: max] + step?: number; // Set sliders step. Always > 0. Could be fractional [Default: 1] + min_interval?: number; // Set minimum diapason between sliders. Only for **double** type [Default: -] + max_interval?: number; // Set minimum maximum between sliders. Only for **double** type [Default: -] + drag_interval?: boolean; // Allow user to drag whole range. Only for **double** type [Default: false] + values?: any[]; // Set up your own array of possible slider values. They could be numbers or strings. If the values array is set up, min, max and step param, can no longer be changed [Default: []] + from_fixed?: boolean; // Fix position of left (or single) handle [Default: false] + from_min?: number; // Set minimum limit for left (or single) handle [Default: min] + from_max?: number; // Set maximum limit for left (or single) handle [Default: max] + from_shadow?: boolean; // Highlight the limits for left handle [Default: false] + to_fixed?: boolean; // Fix position of right handle [Default: false] + to_min?: number; // Set minimum limit for right handle [Default: min] + to_max?: number; // Set maximum limit for right handle [Default: max] + to_shadow?: boolean; // Highlight the right handle [Default: false] + prettify_enabled?: boolean; // Improve readability of long numbers: 10000000 → 10 000 000 [Default: true] + prettify_separator?: string; // Set up your own separator for long numbers: 10000000 → 10,000,000 etc. [Default: ] + prettify?: (num: number) => string; // Set up your own prettify function. Can be anything. For example, you can set up unix time as slider values and than transform them to cool looking dates [Default: null] + force_edges?: boolean; // Sliders handles and tooltips will be always inside it's container [Default: false] + keyboard?: boolean; // Activates keyboard controls. Move left: ←, ↓, A, S. Move right: →, ↑, W, D. [Default: true] + grid?: boolean; // Enables grid of values above the slider [Default: true] + grid_margin?: boolean; // Set left and right grid gaps [Default: true] + grid_num?: number; // Number of grid units [Default: 4] + grid_snap?: boolean; // Snap grid to sliders step (step param). If activated, grid_num will not be used. Max steps = 50 [Default: false] + hide_min_max?: boolean; // Hides **min** and **max** labels [Default: false] + hide_from_to?: boolean; // Hides **from** and **to** labels [Default: false] + prefix?: string; // Set prefix for values. Will be set up right before the number: **$**100 [Default: ] + postfix?: string; // Set postfix for values. Will be set up right after the number: 100**k** [Default: ] + max_postfix?: string; // Special postfix, used only for maximum value. Will be showed after handle will reach maximum right position. For example **0 — 100+** [Default: ] + decorate_both?: boolean; // Used for **double** type and only if prefix or postfix was set up. Determine how to decorate close values. For example: **$10k — $100k** or **$10 — 100k** [Default: true] + values_separator?: string; // Set your own separator for close values. Used for **double** type. Default: **10 — 100**. Or you may set: **10 to 100, 10 + 100, 10 → 100** etc. [Default: - ] + input_values_separator?: string; // Separator for **double** values in input value property. ` [Default: ; ] + disable?: boolean; // Locks slider and makes it inactive. Input is disabled too. Invisible to forms [Default: false] + block?: boolean; // Locks slider and makes it inactive. Input is NOT disabled. Can be send with forms [Default: false] + extra_classes?: string; // Traverse extra CSS-classes to sliders container [Default: —] + scope?: any; // Scope for callbacks. Pass any object [Default: null] + onStart?: (obj: IonRangeSliderEvent) => void; // Callback. Is called on slider start. Gets all slider data as a 1st attribute [Default: null] + onChange?: (obj: IonRangeSliderEvent) => void; // Callback. IS called on each values change. Gets all slider data as a 1st attribute [Default: null] + onFinish?: (obj: IonRangeSliderEvent) => void; // Callback. Is called when user releases handle. Gets all slider data as a 1st attribute [Default: null] + onUpdate?: (obj: IonRangeSliderEvent) => void; // Callback. Is called when slider is modified by external methods `update` or `reset [Default: null] +} + +export interface IonRangeSliderEvent { + input: JQuery; // jQuery-link to input + slider: JQuery; // jQuery-link to sliders container + min: number; // MIN value + max: number; // MAX values + from: number; // FROM value + from_percent: number; // FROM value in percents + from_value: number; // FROM index in values array (if used) + to: number; // TO value + to_percent: number; // TO value in percents + to_value: number; // TO index in values array (if used) + min_pretty: string; // MIN prettified (if used) + max_pretty: string; // MAX prettified (if used) + from_pretty: string; // FROM prettified (if used) + to_pretty: string; // TO prettified (if used) +} diff --git a/types/ion.rangeslider/ion.rangeslider-tests.ts b/types/ion-rangeslider/ion-rangeslider-tests.ts similarity index 67% rename from types/ion.rangeslider/ion.rangeslider-tests.ts rename to types/ion-rangeslider/ion-rangeslider-tests.ts index e60287feb3..e3bffdd4b6 100644 --- a/types/ion.rangeslider/ion.rangeslider-tests.ts +++ b/types/ion-rangeslider/ion-rangeslider-tests.ts @@ -1,6 +1,5 @@ /// - -var sliderInputElement = $(''); +let sliderInputElement = $(''); sliderInputElement.ionRangeSlider({ decorate_both: true, disable: false, @@ -18,29 +17,18 @@ sliderInputElement.ionRangeSlider({ hide_from_to: false, hide_min_max: false, keyboard: true, - keyboard_step: 1, max: 100, max_interval: 5, max_postfix: "+", min: 10, min_interval: 5, - onChange: function (obj) { - console.log(obj); - }, - onFinish: function (obj) { - console.log(obj); - }, - onStart: function (obj) { - console.log(obj); - }, - onUpdate: function (obj) { - console.log(obj); - }, + onChange: obj => console.log(obj), + onFinish: obj => console.log(obj), + onStart: obj => console.log(obj), + onUpdate: obj => console.log(obj), postfix: ".00", prefix: "$", - prettify: function(num) { - return String(num); - }, + prettify: (num: number) => (String(num)), prettify_enabled: true, prettify_separator: ",", step: 10, @@ -48,8 +36,7 @@ sliderInputElement.ionRangeSlider({ to_fixed: false, to_max: 100, to_min: 60, - to_shadowed: false, - type: "double", + type: "double", values: ["a", "b", "c"], values_separator: "," }); diff --git a/types/ion.rangeslider/tsconfig.json b/types/ion-rangeslider/tsconfig.json similarity index 76% rename from types/ion.rangeslider/tsconfig.json rename to types/ion-rangeslider/tsconfig.json index 1affa9f527..2c77a196bd 100644 --- a/types/ion.rangeslider/tsconfig.json +++ b/types/ion-rangeslider/tsconfig.json @@ -7,8 +7,8 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": false, "strictFunctionTypes": true, + "strictNullChecks": true, "baseUrl": "../", "typeRoots": [ "../" @@ -19,6 +19,10 @@ }, "files": [ "index.d.ts", - "ion.rangeslider-tests.ts" + "ion-rangeslider-tests.ts" + ], + "exclude": [ + "util/**/*", + ".gitignore" ] -} \ No newline at end of file +} diff --git a/types/ion-rangeslider/tslint.json b/types/ion-rangeslider/tslint.json new file mode 100644 index 0000000000..64aace11d6 --- /dev/null +++ b/types/ion-rangeslider/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "max-line-length": false + } +} diff --git a/types/ion.rangeslider/v1/index.d.ts b/types/ion-rangeslider/v1/index.d.ts similarity index 91% rename from types/ion.rangeslider/v1/index.d.ts rename to types/ion-rangeslider/v1/index.d.ts index d819f46964..2ce88db6d4 100644 --- a/types/ion.rangeslider/v1/index.d.ts +++ b/types/ion-rangeslider/v1/index.d.ts @@ -1,6 +1,7 @@ -// Type definitions for for Ion.RangeSlider 1.9.1 +// Type definitions for ion-rangeslider 1.9 // Project: https://github.com/IonDen/ion.rangeSlider/ // Definitions by: Douglas Eichelberger +// Karel van de Plassche // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 diff --git a/types/ion.rangeslider/v1/ion.rangeslider-tests.ts b/types/ion-rangeslider/v1/ion-rangeslider-tests.ts similarity index 100% rename from types/ion.rangeslider/v1/ion.rangeslider-tests.ts rename to types/ion-rangeslider/v1/ion-rangeslider-tests.ts diff --git a/types/ion.rangeslider/v1/tsconfig.json b/types/ion-rangeslider/v1/tsconfig.json similarity index 83% rename from types/ion.rangeslider/v1/tsconfig.json rename to types/ion-rangeslider/v1/tsconfig.json index c63da8c0e1..32d3577e6f 100644 --- a/types/ion.rangeslider/v1/tsconfig.json +++ b/types/ion-rangeslider/v1/tsconfig.json @@ -15,8 +15,8 @@ ], "types": [], "paths": { - "ion.rangeslider": [ - "ion.rangeslider/v1" + "ion-rangeslider": [ + "ion-rangeslider/v1" ] }, "noEmit": true, @@ -24,6 +24,6 @@ }, "files": [ "index.d.ts", - "ion.rangeslider-tests.ts" + "ion-rangeslider-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/ion.rangeslider/tslint.json b/types/ion-rangeslider/v1/tslint.json similarity index 100% rename from types/ion.rangeslider/tslint.json rename to types/ion-rangeslider/v1/tslint.json diff --git a/types/ion.rangeslider/index.d.ts b/types/ion.rangeslider/index.d.ts deleted file mode 100644 index 21d99c5c6d..0000000000 --- a/types/ion.rangeslider/index.d.ts +++ /dev/null @@ -1,71 +0,0 @@ -// Type definitions for for Ion.RangeSlider 2.0.2 -// Project: https://github.com/IonDen/ion.rangeSlider/ -// Definitions by: Sixin Li -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 - -// API documentation: http://ionden.com/a/plugins/ion.rangeSlider/en.html - -interface JQuery { - destroy(): void; - ionRangeSlider(): JQuery; - ionRangeSlider(options: IonRangeSliderOptions): JQuery; - reset(): void; - update(option: IonRangeSliderOptions): void; -} - -interface IonRangeSliderOptions { - decorate_both?: boolean; - disable?: boolean; - drag_interval?: boolean; - force_edges?: boolean; - from?: number; - from_fixed?: boolean; - from_max?: number; - from_min?: number; - from_shadow?: boolean; - grid?: boolean; - grid_margin?: boolean; - grid_num?: number; - grid_snap?: boolean; - hide_from_to?: boolean; - hide_min_max?: boolean; - keyboard?: boolean; - keyboard_step?: number; - max?: number; - max_interval?: number; - max_postfix?: string; - min?: number; - min_interval?: number; - onChange?: (obj: IonRangeSliderEvent) => void; - onFinish?: (obj: IonRangeSliderEvent) => void; - onStart?: (obj: IonRangeSliderEvent) => void; - onUpdate?: (obj: IonRangeSliderEvent) => void; - postfix?: string; - prefix?: string; - prettify?: (num: number) => string; - prettify_enabled?: boolean; - prettify_separator?: string; - step?: number; - to?: number; - to_fixed?: boolean; - to_max?: number; - to_min?: number; - to_shadowed?: boolean; - type?: string; - values?: any[]; - values_separator?: string; -} - -interface IonRangeSliderEvent { - from: number; - from_precent: number; - from_value: any; - input: JQuery; - max: number; - min: number; - slider: JQuery; - to: number; - to_precent: number; - to_value: any; -} diff --git a/types/ion.rangeslider/v1/tslint.json b/types/ion.rangeslider/v1/tslint.json deleted file mode 100644 index a41bf5d19a..0000000000 --- a/types/ion.rangeslider/v1/tslint.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "extends": "dtslint/dt.json", - "rules": { - "adjacent-overload-signatures": false, - "array-type": false, - "arrow-return-shorthand": false, - "ban-types": false, - "callable-types": false, - "comment-format": false, - "dt-header": false, - "eofline": false, - "export-just-namespace": false, - "import-spacing": false, - "interface-name": false, - "interface-over-type-literal": false, - "jsdoc-format": false, - "max-line-length": false, - "member-access": false, - "new-parens": false, - "no-any-union": false, - "no-boolean-literal-compare": false, - "no-conditional-assignment": false, - "no-consecutive-blank-lines": false, - "no-construct": false, - "no-declare-current-package": false, - "no-duplicate-imports": false, - "no-duplicate-variable": false, - "no-empty-interface": false, - "no-for-in-array": false, - "no-inferrable-types": false, - "no-internal-module": false, - "no-irregular-whitespace": false, - "no-mergeable-namespace": false, - "no-misused-new": false, - "no-namespace": false, - "no-object-literal-type-assertion": false, - "no-padding": false, - "no-redundant-jsdoc": false, - "no-redundant-jsdoc-2": false, - "no-redundant-undefined": false, - "no-reference-import": false, - "no-relative-import-in-test": false, - "no-self-import": false, - "no-single-declare-module": false, - "no-string-throw": false, - "no-unnecessary-callback-wrapper": false, - "no-unnecessary-class": false, - "no-unnecessary-generics": false, - "no-unnecessary-qualifier": false, - "no-unnecessary-type-assertion": false, - "no-useless-files": false, - "no-var-keyword": false, - "no-var-requires": false, - "no-void-expression": false, - "no-trailing-whitespace": false, - "object-literal-key-quotes": false, - "object-literal-shorthand": false, - "one-line": false, - "one-variable-per-declaration": false, - "only-arrow-functions": false, - "prefer-conditional-expression": false, - "prefer-const": false, - "prefer-declare-function": false, - "prefer-for-of": false, - "prefer-method-signature": false, - "prefer-template": false, - "radix": false, - "semicolon": false, - "space-before-function-paren": false, - "space-within-parens": false, - "strict-export-declare-modifiers": false, - "trim-file": false, - "triple-equals": false, - "typedef-whitespace": false, - "unified-signatures": false, - "void-return": false, - "whitespace": false - } -}