Prevent Scroll

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

FeaturesSection titled Features

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

InstallationSection titled Installation

npm install solid-prevent-scroll

UsageSection titled Usage

By default, it also hides the scrollbar of the document 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 document 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,
    hideScrollbar: true, // 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>

API referenceSection titled API reference