# @types/react-ranger

> TypeScript definitions for react-ranger

Latest version **2.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-ranger
pnpm add @types/react-ranger
yarn add @types/react-ranger
bun add @types/react-ranger
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.4 |
| Published | 2023-11-07 |
| First published | 2020-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-ranger
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-ranger
- npm.io page: https://npm.io/package/@types/react-ranger

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 2.0.4 (latest) — 2023-11-07
- 2.0.1 (ts3.6) — 2021-07-08
- 2.0.0 (ts3.0) — 2020-07-31
- 2.0.3 — 2023-10-18
- 2.0.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-ranger`

# Summary
This package contains type definitions for react-ranger (https://github.com/tannerlinsley/react-ranger#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-ranger.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-ranger/index.d.ts)
````ts
import { CSSProperties, Key, MouseEvent, TouchEvent } from "react";

export interface RangerOptions {
    values: number[];
    min: number;
    max: number;
    stepSize: number;
    steps?: number[] | undefined;
    tickSize?: number | undefined;
    ticks?: number[] | undefined;
    onChange?: ((values: number[]) => void) | undefined;
    onDrag?: ((values: number[]) => void) | undefined;
    interpolator?: {
        getPercentageForValue: (val: number, min: number, max: number) => number;
        getValueForClientX: (clientX: number, trackDims: object, min: number, max: number) => number;
    } | undefined;
}

export interface TrackProps {
    key: Key;
    style: CSSProperties;
}
export interface TickProps {
    key: Key;
    style: CSSProperties;
}
export interface SegmentProps {
    key: Key;
    style: CSSProperties;
}
export interface HandleProps {
    key: Key;
    style: CSSProperties;
    onMouseDown: (event: MouseEvent) => void;
    onTouchStart: (event: TouchEvent) => void;
    tabIndex: number;
}

export interface RangerTick {
    value: number;
    getTickProps: <T>(props?: T) => T & TickProps;
}

export interface RangerSegment {
    value: number;
    getSegmentProps: <T>(props?: T) => T & SegmentProps;
}

export interface RangerHandle {
    value: number;
    active: boolean;
    getHandleProps: <T>(props?: T) => T & HandleProps;
}

export interface Ranger {
    getTrackProps: <T>(props?: T) => T & TrackProps;
    ticks: RangerTick[];
    segments: RangerSegment[];
    handles: RangerHandle[];
    activeHandleIndex: number | null;
}

export function useRanger(options: RangerOptions): Ranger;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Matt Polichette](https://github.com/mpolichette), and [Guy Gascoigne-Piggford](https://github.com/ggascoigne).

---
_Source: https://npm.io/package/@types/react-ranger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._