mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-06-01 00:50:04 +00:00
225 lines
9.2 KiB
TypeScript
225 lines
9.2 KiB
TypeScript
// Type definitions for nouislider v9.0.1
|
|
// Project: https://github.com/leongersen/noUiSlider
|
|
// Definitions by: Patrick Davies <https://github.com/bleuarg>, Guust Nieuwenhuis <https://github.com/lagaffe>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
/// <reference types="wnumb"/>
|
|
|
|
export = noUiSlider;
|
|
export as namespace noUiSlider;
|
|
|
|
declare namespace noUiSlider {
|
|
/**
|
|
* To create a slider, call noUiSlider.create() with an element and your options.
|
|
*/
|
|
function create(target: HTMLElement, options: Options): noUiSlider.noUiSlider;
|
|
|
|
interface Options {
|
|
/**
|
|
* The start option sets the number of handles and their start positions, relative to range.
|
|
*/
|
|
start: number | number[] | number[][];
|
|
/**
|
|
* All values on the slider are part of a range. The range has a minimum and maximum value.
|
|
* The minimum value cannot be equal to the maximum value.
|
|
*/
|
|
range: { [key: string]: number | number[] };
|
|
/**
|
|
* The connect option can be used to control the bar between the handles or the edges of the slider.
|
|
* If you are using one handle, set the value to either `upper` or `lower`.
|
|
* For sliders with 2 or more handles, pass an array with a boolean for every connecting element,
|
|
* including the edges of the slider. The length of this array must match the handle `count + 1`.
|
|
* Setting `true` sets the bars between the handles, but not between the handles and the sliders edges.
|
|
*/
|
|
connect?: 'lower' | 'upper' | boolean | boolean[];
|
|
/**
|
|
* When using two handles, the minimum distance between the handles can be set using the margin option.
|
|
* The margin value is relative to the value set in 'range'.
|
|
* This option is only available on standard linear sliders.
|
|
*/
|
|
margin?: number;
|
|
/**
|
|
* The limit option is the opposite of the margin option,
|
|
* limiting the maximum distance between two handles.
|
|
* As with the margin option, the limit option can only be used on linear sliders.
|
|
*/
|
|
limit?: number;
|
|
/**
|
|
* Padding limits how close to the slider edges handles can be.
|
|
*/
|
|
padding?: number;
|
|
/**
|
|
* By default, the slider slides fluently.
|
|
* In order to make the handles jump between intervals, you can use this option.
|
|
* The step option is relative to the values provided to range.
|
|
*/
|
|
step?: number;
|
|
/**
|
|
* The orientation setting can be used to set the slider to "vertical" or "horizontal".
|
|
* Set dimensions! Vertical sliders don't assume a default height, so you'll need to set one.
|
|
* You can use any unit you want, including % or px.
|
|
*/
|
|
orientation?: 'vertical' | 'horizontal';
|
|
/**
|
|
* By default the sliders are top-to-bottom and left-to-right,
|
|
* but you can change this using the direction option,
|
|
* which decides where the upper side of the slider is.
|
|
*/
|
|
direction?: 'ltr' | 'rtl';
|
|
/**
|
|
* noUiSlider can provide a basic tooltip without using its events system.
|
|
* Set the tooltips option to true to enable.
|
|
* This option can also accept formatting options to format the tooltips content.
|
|
* In that case, pass an array with a formatter for each handle, true to use the default or false to display no tooltip.
|
|
*/
|
|
tooltips?: boolean | Object | ((...args: any[]) => any);
|
|
/**
|
|
* Set the animate option to false to prevent the slider from animating to a new value with when calling .val().
|
|
*/
|
|
animate?: boolean;
|
|
/**
|
|
* The animationDuration option can be used to set the animation speed assumed by the slider library.
|
|
* In addition to this, you must manually set the CSS (-webkit-)transition property for the .noUi-state-tap .noUi-origin selector.
|
|
*/
|
|
animationDuration?: number;
|
|
/**
|
|
* When a non-linear slider has been configured, the snap option can be set to true to force the slider to jump
|
|
* between the specified values.
|
|
*/
|
|
snap?: boolean;
|
|
/**
|
|
* All values on the slider are part of a range. The range has a minimum and maximum value.
|
|
*/
|
|
behaviour?: string;
|
|
/**
|
|
* To format the slider output, noUiSlider offers a format option.
|
|
* Simply specify to and from functions to encode and decode the values.
|
|
* See manual formatting to the right for usage information.
|
|
* By default, noUiSlider will format output with 2 decimals.
|
|
*/
|
|
format?: Object | ((...args: any[]) => any);
|
|
/**
|
|
* Allows you to generate points along the slider.
|
|
*/
|
|
pips?: PipsOptions;
|
|
}
|
|
|
|
/**
|
|
* Update options that can not be updated will be ignored without errors.
|
|
* The value null can be used to unset a previously set value.
|
|
*/
|
|
type UpdateOptions = Partial<Options>;
|
|
|
|
interface PipsOptions {
|
|
/**
|
|
* The 'range' mode uses the slider range to determine where the pips should be. A pip is generated for every percentage specified.
|
|
*
|
|
* The 'steps', like 'range', uses the slider range. In steps mode, a pip is generated for every step.
|
|
* The 'filter' option can be used to filter the generated pips from the 'steps' options'
|
|
* The filter function must return 0 (no value), 1 (large value) or 2 (small value).
|
|
*
|
|
* In 'positions' mode, pips are generated at percentage-based positions on the slider.
|
|
* Optionally, the stepped option can be set to true to match the pips to the slider steps.
|
|
*
|
|
* The 'count' mode can be used to generate a fixed number of pips. As with positions mode, the stepped option can be used.
|
|
*
|
|
* The 'values' mode is similar to positions, but it accepts values instead of percentages. The stepped option can be used for this mode.
|
|
*
|
|
*/
|
|
mode: 'range' | 'steps' | 'positions' | 'count' | 'values';
|
|
/**
|
|
* Range Mode: percentage for range mode
|
|
* Step Mode: step number for steps
|
|
* Positions Mode: percentage-based positions on the slider
|
|
* Count Mode: positions between pips
|
|
*/
|
|
density?: number;
|
|
/**
|
|
* Step Mode: The filter option can be used to filter the generated pips.
|
|
* The filter function must return 0 (no value), 1 (large value) or 2 (small value).
|
|
*/
|
|
filter?: (...args: any[]) => PipFilterResult;
|
|
/**
|
|
* format for step mode
|
|
* see noUiSlider format
|
|
*/
|
|
format?: Object | ((...args: any[]) => any);
|
|
/**
|
|
*
|
|
* values for positions and values mode
|
|
* number pips for count mode
|
|
*/
|
|
values?: number | number[];
|
|
/**
|
|
* stepped option for positions, values and count mode
|
|
*/
|
|
stepped?: boolean;
|
|
}
|
|
|
|
const enum PipFilterResult {
|
|
NoValue,
|
|
LargeValue,
|
|
SmallValue,
|
|
}
|
|
|
|
interface Callback {
|
|
/**
|
|
* Array for both one-handle and two-handle sliders. It contains the current slider values,
|
|
* with formatting applied.
|
|
*/
|
|
(values: any[], handle: number, unencodedValues: number[]): void;
|
|
}
|
|
|
|
interface noUiSlider {
|
|
/**
|
|
* Bind event to the slider.
|
|
*/
|
|
on(eventName: string, callback: Callback): void;
|
|
/**
|
|
* Unbind event to the slider.
|
|
*/
|
|
off(eventName: string): void;
|
|
/**
|
|
* Destroy's the slider.
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* To get the current slider value. For one-handle sliders, calling .get() will return the value.
|
|
* For two-handle sliders, an array[value, value] will be returned.
|
|
*/
|
|
get(): string | string[];
|
|
/**
|
|
* noUiSlider will keep your values within the slider range, which saves you a bunch of validation.
|
|
* If you have configured the slider to use one handle, you can change the current value by passing
|
|
* a number to the .set() method. If you have two handles, pass an array. One-handled sliders
|
|
* will also accept arrays. Within an array, you can set one position to null
|
|
* if you want to leave a handle unchanged.
|
|
*/
|
|
set(value: number | (number | null)[]): void;
|
|
/**
|
|
* To return to the initial slider values, you can use the .reset() method. This will only reset the slider values.
|
|
*/
|
|
reset(): void;
|
|
/**
|
|
* Exposes the options used to create the noUiSlider instance
|
|
*/
|
|
options: Options;
|
|
/**
|
|
* `noUiSlider` has an update method that can change the `margin`,
|
|
* `padding`, `limit`, `step`, `range`, `pips`, `tooltips`, `animate` and `snap` options.
|
|
* All other options require changes to the slider's HTML or event bindings.
|
|
* Options that can not be updated will be ignored without errors.
|
|
* The value null can be used to unset a previously set value.
|
|
* The `set` event fires when the slider values are restored.
|
|
* If this is unwanted, you can pass false as the second parameter, `fireSetEvent`.
|
|
* Note that if you initiate multiple sliders using the same options object
|
|
* and update a subset of them later, this will move the options property out of sync
|
|
* with the actual slider options.
|
|
*/
|
|
updateOptions(newOptions: UpdateOptions, fireSetEvent?: boolean): void;
|
|
}
|
|
|
|
interface Instance extends HTMLElement {
|
|
noUiSlider: noUiSlider;
|
|
}
|
|
}
|