# Headroom.js

JavaScript widget that hides a page header while the user scrolls down and shows it again when they scroll up.

STUB. This software has no release or pre-release in four years, or its project site no longer shows it, so it is not part of the register, not counted and not indexed. It will be checked again.

Source: https://findsoftware.frbit.cloud/headroom/
Last reviewed: 2026-11-09
Listed since: 2026-11-09

## Record

### Links

- home: https://wicky.nillia.ms/headroom.js/
- repository: https://github.com/WickyNilliams/headroom.js
- docs: https://wicky.nillia.ms/headroom.js/
- x: https://twitter.com/WickyNilliams

### Identity

- status: stub
- maintainer: Nick Williams
- maintainerType: individual
- parent: unknown
- firstRelease: 2013
- hqCountry: unknown

### Kind

- category: ui-library
- hosting: not applicable
- language: javascript
- runtime: unknown
- runtimeMin: not applicable
- basedOn: unknown

### Content

- contentStore: not applicable
- databases: not applicable
- adminUi: not applicable
- headlessApi: not applicable
- templating: not applicable
- i18n: not applicable

### Rendering and deploy

- runsAs: not applicable
- renderingModes: not applicable
- installMethod: npm

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 0
- latestReleaseDate: 2020-10-16

### Adoption

- githubStargazers: 10842
- packagistDownloads: not applicable
- npmWeeklyDownloads: 45066
- contributors: 27
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 1492
- dependentPackages: 48

### Sources

- urls: https://wicky.nillia.ms/headroom.js/ (read 2026-11-09)
- urls: https://github.com/WickyNilliams/headroom.js (read 2026-11-09)
- urls: https://wicky.nillia.ms/headroom.js/ (read 2026-11-09)
- maintainer: https://github.com/WickyNilliams/headroom.js/blob/master/LICENSE (read 2026-11-09)
- maintainerType: https://github.com/WickyNilliams/headroom.js/blob/master/LICENSE (read 2026-11-09)
- firstRelease: https://api.github.com/repos/WickyNilliams/headroom.js/commits/v0.3.9 (read 2026-11-09)
- category: https://github.com/WickyNilliams/headroom.js/blob/master/README.md (read 2026-11-09)
- language: https://github.com/WickyNilliams/headroom.js (read 2026-11-09)
- installMethod: https://github.com/WickyNilliams/headroom.js/blob/master/README.md (read 2026-11-09)
- installMethod: https://github.com/WickyNilliams/headroom.js/blob/master/README.md (read 2026-11-09)
- installMethod: https://wicky.nillia.ms/headroom.js/ (read 2026-11-09)
- license: https://github.com/WickyNilliams/headroom.js/blob/master/README.md (read 2026-11-09)
- licenseModel: https://github.com/WickyNilliams/headroom.js/blob/master/README.md (read 2026-11-09)
- currentMajor: https://registry.npmjs.org/headroom.js (read 2026-11-09)
- latestReleaseDate: https://registry.npmjs.org/headroom.js (read 2026-11-09)
- githubStargazers: https://api.github.com/repos/WickyNilliams/headroom.js (read 2026-11-09)
- contributors: https://api.github.com/repos/WickyNilliams/headroom.js/contributors?per_page=1 (read 2026-11-09)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/range/2026-11-01:2026-11-07/headroom.js (read 2026-11-09)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/headroom.js (read 2026-11-09)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/headroom.js (read 2026-11-09)

## Notes

Headroom.js hides a page's header while the user scrolls down and shows it again on scroll up. It is written in JavaScript and has no dependencies. A page creates a Headroom instance for a header element and calls its init method; CSS classes for the pinned and unpinned states move the header in and out of view. The [documentation site](https://wicky.nillia.ms/headroom.js/) lists the methods, including freeze and unfreeze, which stop and resume the scroll response. It has a pure JavaScript API plus an optional jQuery plugin and AngularJS directive. The package is installed from npm or yarn, or loaded from unpkg.com for script tags.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0