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

use-scrollock

v1.0.6

Published

Locks/ Unlock scroll for <body /> or other component.

Downloads

15

Readme

use-scrollock

Locks/ Unlock scroll for <body /> or other component.

NPM JavaScript Style Guide

Install

Using npm:

npm install --save use-scrollock

Using yarn:

yarn add use-scrollock

Usage

import * as React from "react";

import { useClipboard } from "use-scrollock";

const Example = () => {
  const { scrollock, toggleScrollock } = useClipboard();

  return <div style={{ height: "100vh", background: "purple" }}>hello</div>;
};

API

UseScrollockProps(options: UseScrollockProps): UseScrollockReturnType

UseScrollockProps

  • disableHorizontalScroll - Disables horizontal scroll. Defaults to true.
  • disableVerticalScroll - Disables vertical scroll. Defaults to true.
  • padScrollbarSpace - Should the scroll bar space be preserved. Defaults to false.
  • ref - Provide reference to a component other than body.

UseScrollockReturntype

  • scrollock - Incicates the current scrollock state.
  • toggleScrollock(value: boolean) - toggles the scrollock state, you can manually set the value too.

Live Demo

Found this project useful? ❤️

If you found this project useful, then please consider giving it a ⭐️ on Github and sharing it with your friends via social media.

Issues and feedback 💭

If you have any suggestion for including a feature or if something doesn't work, feel free to open a Github issue for us to have a discussion on it.

License

MIT © fayeed


This hook is created using create-react-hook.