# @types/react-outside-click-handler

> TypeScript definitions for react-outside-click-handler

Latest version **1.3.4** (published 2024-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-outside-click-handler
pnpm add @types/react-outside-click-handler
yarn add @types/react-outside-click-handler
bun add @types/react-outside-click-handler
```

## 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 | 1.3.4 |
| Published | 2024-09-25 |
| First published | 2018-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.3.4 (latest) — 2024-09-25
- 1.3.3 (ts4.7) — 2023-11-07
- 1.3.1 (ts4.4) — 2021-12-23
- 1.3.0 (ts3.2) — 2019-11-27
- 1.3.2 — 2023-10-18
- 1.2.0 — 2018-10-05

## README

# Installation
> `npm install --save @types/react-outside-click-handler`

# Summary
This package contains type definitions for react-outside-click-handler (https://github.com/airbnb/react-outside-click-handler).

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

declare namespace OutsideClickHandler {
    interface DefaultProps {
        /**
         * If the disabled prop is true, outside clicks will not be registered. This can be
         * utilized to temporarily disable interaction without unmounting/remounting the entire
         * tree.
         *
         * @default false
         */
        disabled: boolean;
        /**
         * If useCapture is true, the event will be registered in the capturing phase and thus,
         * propagated top-down instead of bottom-up as is the default.
         *
         * @default true
         */
        useCapture: boolean;
        /**
         * By default, the OutsideClickHandler renders a display: block <div /> to wrap the
         * subtree defined by children. If desired, the display can be set to inline-block,
         * inline, flex, or contents instead. There is no way not to render a wrapping <div />.
         *
         * @default "block"
         */
        display: "block" | "flex" | "inline" | "inline-block" | "contents";
    }

    interface Props extends Partial<DefaultProps> {
        /**
         * Since the OutsideClickHandler specifically handles clicks outside a specific subtree,
         * children is expected to be defined. A consumer should also not render the
         * OutsideClickHandler in the case that children are not defined.
         */
        children: React.ReactNode;

        /**
         * It takes the relevant clickevent as an arg and gets triggered when the user clicks
         * anywhere outside of the subtree generated by the DOM node.
         */
        onOutsideClick: (e: MouseEvent) => void;
    }
}

declare class OutsideClickHandler extends React.Component<OutsideClickHandler.Props> {
    static defaultProps: OutsideClickHandler.DefaultProps;
}

export = OutsideClickHandler;

````

### Additional Details
 * Last updated: Wed, 25 Sep 2024 19:19:36 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Ivan Zub](https://github.com/zubivan), [JadowityHerbatnik](https://github.com/JadowityHerbatnik), and [Adam Jones](https://github.com/domdomegg).

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