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

solid-prevent-scroll

v0.1.10

Published

SolidJS utility that prevents scrolling outside of a given DOM element. Works by preventing events that else would lead to scrolling.

Downloads

33,571

Readme

SolidJS utility that prevents scrolling outside of a given DOM element. Works by preventing events that else would lead to scrolling.

Features

  • Supports nested scroll containers
  • Works both vertically and horizontally
  • Removes the body scrollbar without layout shift

Usage

By default, it also hides the scrollbar of the body element and adds padding to it to prevent the page from jumping. This behavior can be disabled and modified with the hideScrollbar, preventScrollbarShift, and preventScrollbarShiftMode props.

It also adds the CSS variable --scrollbar-width to the body element, indicating the width of the currently removed scrollbar. You can use this variable to add padding to fixed elements, like a topbar.

import createPreventScroll from 'solid-prevent-scroll'
const DialogContent: Component<{
  open: boolean
}> = (props) => {
  const [ref, setRef] = createSignal(null)

  createPreventScroll({
    element: ref,
    enabled: () => props.open, // default = true
    hideScrollbar: true, // default
    preventScrollbarShift: true, // default
    preventScrollbarShiftMode: 'padding', // default, `padding` or `margin`
    restoreScrollPosition: true, // default
    allowPinchZoom: false, // default
  })

  return (
    <Show when={props.open()}>
      <div ref={setRef}>Dialog</div>
    </Show>
  )
}

Use the --scrollbar-width CSS variable to add padding to fixed elements to prevent the content from shifting when the scrollbar is removed:

<header
  class="fixed top-0 inset-x-0 z-50"
  style={{
    'padding-right': 'var(--scrollbar-width, 0)',
  }}
>
  Header
</header>

Further Reading

This utility is from the maintainers of corvu, a collection of unstyled, accessible and customizable UI primitives for SolidJS. It is also documented in the corvu docs under Prevent Scroll.