# @types/react-typist

> TypeScript definitions for react-typist

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

## Install

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

## 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.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 | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 2.0.6 (latest) — 2023-11-07
- 2.0.3 (ts3.7) — 2021-10-15
- 2.0.2 (ts3.6) — 2021-07-08
- 2.0.1 (ts3.1) — 2019-08-23
- 2.0.5 — 2023-10-18
- 2.0.4 — 2023-09-27
- 2.0.0 — 2019-04-17

## README

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

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

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-typist.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-typist/index.d.ts)
````ts
import * as React from "react";

export namespace Typist {
    interface CursorProps {
        show?: boolean | undefined;
        blink?: boolean | undefined;
        element?: string | undefined;
        hideWhenDone?: boolean | undefined;
        hideWhenDoneDelay?: number | undefined;
    }

    interface CurrentTextProps {
        line: string;
        lineIdx: number;
        character: string;
        charIdx: number;
        defDelayGenerator: (mn: number, st: number) => (...params: any) => number;
    }

    interface DelayProps {
        ms: number;
    }
    class Delay extends React.Component<DelayProps> {}

    interface BackSpaceProps {
        count?: number | undefined;
        delay?: number | undefined;
    }
    class Backspace extends React.Component<BackSpaceProps> {}
}

export interface TypistProps {
    children?: React.ReactNode;
    className?: string | undefined;
    avgTypingDelay?: number | undefined;
    stdTypingDelay?: number | undefined;
    startDelay?: number | undefined;
    cursor?: Typist.CursorProps | undefined;
    onCharacterTyped?: ((char: string, charIndex: number) => void) | undefined;
    onLineTyped?: ((line: string, lineIndex: number) => void) | undefined;
    onTypingDone?: (() => void) | undefined;
    delayGenerator?: ((mean: number, std: number, current: Typist.CurrentTextProps) => number) | undefined;
}

export class Typist extends React.Component<TypistProps> {}

export default Typist;

````

### 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 [Shawn Choi](https://github.com/shawnkoon).

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