# react-headroom

> Hide your header until you need it. React.js port of headroom.js

Latest version **3.2.1** (published 2022-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-headroom
pnpm add react-headroom
yarn add react-headroom
bun add react-headroom
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.1 |
| Published | 2022-09-26 |
| First published | 2015-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/react-headroom) |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 41.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1872 |
| Author | Kyle Mathews |
| Maintainers | kylemathews, endymion1818, janczizikow |
| Keywords | headroom, react, react-component |

## Links

- npm: https://www.npmjs.com/package/react-headroom
- Repository: https://github.com/KyleAMathews/react-headroom
- Issues: https://github.com/KyleAMathews/react-headroom/issues
- npm.io page: https://npm.io/package/react-headroom

## Dependencies (3)

- [raf](https://npm.io/package/raf.md) ^3.3.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8
- [shallowequal](https://npm.io/package/shallowequal.md) ^1.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.2.1 (latest) — 2022-09-26
- 3.2.0 — 2021-10-10
- 3.1.1 — 2021-03-30
- 3.1.0 — 2020-12-03
- 3.0.1 — 2020-11-25
- 3.0.0 — 2019-10-12
- 2.2.8 — 2019-03-07
- 2.2.7 — 2019-03-01
- 2.2.6 — 2019-02-28
- 2.2.5 — 2019-02-28
- 2.2.4 — 2018-09-21
- 2.2.3 — 2018-09-21
- 2.2.2 — 2017-10-19
- 2.2.1 — 2017-09-26
- 2.2.0 — 2017-09-25
- … 30 more at https://npm.io/package/react-headroom/versions

## README

# react-headroom
Hide your header until you need it.

## Demo
http://kyleamathews.github.io/react-headroom

## Install
`npm install react-headroom`

## Usage
A simple example, [see the docs site](http://kyleamathews.github.io/react-headroom/)
for more examples and documentation.

```html
<Headroom>
  <h1>You can put anything you'd like inside the Headroom Component</h1>
</Headroom>
```

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