# @types/react-hooks-helper

> TypeScript definitions for react-hooks-helper

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

## Install

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

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.6 |
| Published | 2023-11-07 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.6.6 (latest) — 2023-11-07
- 1.6.4 (ts3.6) — 2021-07-08
- 1.6.3 (ts3.5) — 2021-03-10
- 1.6.2 (ts2.8) — 2019-04-29
- 1.6.5 — 2023-10-18
- 1.6.1 — 2019-04-18
- 1.6.0 — 2019-04-17

## README

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

# Summary
This package contains type definitions for react-hooks-helper (https://github.com/revelcw/react-hooks-helper#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-hooks-helper.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-hooks-helper/index.d.ts)
````ts
/// <reference types="react"/>

export as namespace ReactHooksHelper;

export interface NavigationProps {
    next: () => void;
    previous?: (() => void) | undefined;
    go?: ((step: number | string) => void) | undefined;
    play?: (() => void) | undefined;
    pause?: (() => void) | undefined;
}

export interface Step {
    id: string;
}

export interface UseStepParams {
    initialStep?: number | undefined;
    autoAdvanceDuration?: number | undefined;
    steps: Step[] | number;
}

export interface UseStepResponse {
    autoAdvanceDuration: number;
    isPaused: boolean;
    index: number;
    step: Step | number;
    navigation: NavigationProps;
}

export function useStep(params: UseStepParams): UseStepResponse;

export interface FormTarget {
    target: {
        name: string; // object property name or Dot separated when hierarchical
        value: any;
        type?: string | undefined;
        checked?: boolean | undefined;
    };
}

export type SetForm = (
    event: React.SyntheticEvent<HTMLInputElement> | React.ChangeEvent<HTMLInputElement> | FormTarget,
) => void;

export function useForm<T>(defaultFormConfig: T): [T, SetForm];

````

### 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 [Joao Edmundo](https://github.com/jedmundo).

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