npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ctrl/ngx-headroom

v5.0.0

Published

Headroom.js implementation in Angular

Downloads

3,541

Readme

DEMO: https://ngx-headroom.netlify.com/

An Angular Component to hide/show your header on scroll. A port of of React Headroom by KyleAMathews which was based around headroom.js

Fixed headers are nice for persistent navigation but they can also get in the way by taking up valuable vertical screen space. Using this component lets you have your persistent navigation while preserving screen space when the navigation is not needed.

Dependencies

Latest version available for each version of Angular

| ngx-headroom | Angular | | ------------ | --------- | | 2.3.2 | 6.x 7.x | | 3.0.3 | 8.x 9.x | | 4.0.0 | 10.x 11.x | | current | >= 12.x |

Install

npm install @ctrl/ngx-headroom

Using Angular Headroom

Import the module. Requires @angular/animations

// requires BrowserAnimationsModule
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
// import HeadroomModule
import { HeadroomModule } from '@ctrl/ngx-headroom';

Use the module

<ngx-headroom>
  <h1>You can put anything you'd like inside the Headroom Component</h1>
</ngx-headroom>

Overriding animation

The component is intended to be plug 'n play meaning it has sensible defaults for animating the header in and out. If you'd like to override the default animation.

Override animation defaults by passing your own values

<ngx-headroom duration="500" easing="ease-in-out">
  <h1>You can put anything you'd like inside the Headroom Component</h1>
</ngx-headroom>

Inputs

  • duration — Duration of animation in ms
  • easing — Easing of animation
  • upTolerance — scroll tolerance in px when scrolling up before component is pinned
  • downTolerance — scroll tolerance in px when scrolling down before component is pinned
  • disable — disable pinning and unpinning
  • wrapperStyle — pass styles for the wrapper div (this maintains the components vertical space at the top of the page).
  • parent — provide a custom 'parent' element for scroll events. parent should be a function which resolves to the desired element.
  • pinStart — height in px where the header should start and stop pinning. Useful when you have another element above Headroom component.

Outputs

  • pin - emitted when header is pinned
  • unpin - emitted when header is unpinned
  • unfix - emitted when header position is no longer fixed

GitHub @scttcper  ·  Twitter @scttcper