# @types/react-hint

> TypeScript definitions for react-hint

Latest version **3.2.4** (published 2024-10-07) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 55/100 (C)** — status: stable.

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

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.2.4 |
| Published | 2024-10-07 |
| First published | 2021-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 3.2.4 (latest) — 2024-10-07
- 3.2.3 (ts4.5) — 2023-11-07
- 3.2.0 (ts3.7) — 2021-10-28
- 3.2.2 — 2023-10-18
- 3.2.1 — 2023-09-27

## README

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

# Summary
This package contains type definitions for react-hint (https://github.com/slmgc/react-hint).

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

declare namespace ReactHintFactory {
    interface ReactHintProps {
        /**
         * Allows setting a custom tooltip attribute instead of the default one.
         *
         * @default "data-rh"
         */
        attribute?: string | undefined;

        /**
         * Autopositions tooltips based on closeness to window borders.
         *
         * @default false
         */
        autoPosition?: boolean | undefined;

        /**
         * You can override the tooltip style by passing the className property.
         *
         * @default "react-hint"
         */
        className?: string | undefined;

        /**
         * The default delay (in milliseconds) before showing/hiding the tooltip.
         *
         * @default 0
         */
        delay?: number | { show: number; hide: number } | undefined;

        /**
         * Enables/disables all events or a subset of events.
         *
         * @default false
         */
        events?: boolean | { click: boolean; focus: boolean; hover: boolean } | undefined;

        /**
         * Allows rendering of custom HTML content (with attached event handlers).
         * Pass a function which returns a react node.
         */
        onRenderContent?: ((target: HTMLElement, content: string) => React.ReactNode) | undefined;

        /**
         * Hide the tooltip only on outside click, hover, etc.
         *
         * @default false
         */
        persist?: boolean | undefined;

        /**
         * Allows setting the default tooltip placement.
         *
         * @default "top"
         */
        position?: "top" | "left" | "right" | "bottom" | undefined;
    }
}

declare function ReactHintFactory(react: typeof React): React.ComponentClass<ReactHintFactory.ReactHintProps>;

export = ReactHintFactory;

````

### Additional Details
 * Last updated: Mon, 07 Oct 2024 22:07:58 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Lucas Ghizoni](https://github.com/lucasghizoni).

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