# @types/react-headroom

> TypeScript definitions for react-headroom

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

## Install

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

## 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 | 3.2.3 |
| Published | 2023-11-07 |
| First published | 2018-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 3.2.3 (latest) — 2023-11-07
- 3.2.0 (ts4.1) — 2022-11-14
- 2.2.2 (ts3.6) — 2021-07-08
- 2.2.1 (ts2.8) — 2019-02-13
- 3.2.2 — 2023-10-18
- 3.2.1 — 2023-09-27
- 2.2.0 — 2018-12-31

## README

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

# Summary
This package contains type definitions for react-headroom (https://kyleamathews.github.io/react-headroom/).

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

declare class Headroom extends Component<ReactHeadroomProps> {
    constructor(props: ReactHeadroomProps);
}

export interface ReactHeadroomProps {
    style?: CSSProperties | undefined;
    onPin?: (() => void) | undefined;
    onUnpin?: (() => void) | undefined;
    onUnfix?: (() => void) | undefined;
    upTolerance?: number | undefined;
    downTolerance?: number | undefined;
    disable?: boolean | undefined;
    wrapperStyle?: CSSProperties | undefined;
    parent?: (() => any) | undefined;
    pinStart?: number | undefined;
    calcHeightOnResize?: boolean | undefined;
    disableInlineStyles?: boolean | undefined;
    className?: string | undefined;
    children: ReactNode;
    pin?: boolean | undefined;
    tag?: string | undefined;
}

export default Headroom;

````

### 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 [Zero Cho](https://github.com/zerocho), and [Rafael Derolez](https://github.com/rafaelderolez).

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