Skip to content

Scroll

Bindings for @solid-primitives/scroll.

type ScrollPosition =
    member x: int     // will likely become float
    member y: int

let createScrollPosition(?element: #HtmlElement | Accessor<#HtmlElement>): Accessor<ScrollPosition>
let useWindowScrollPosition(): ScrollPosition
let getScrollPosition(): ScrollPosition
  • createScrollPosition tracks an element's scroll position. The target defaults to window.
  • useWindowScrollPosition tracks the window's. Its signals and listeners are shared by every caller, so it is cheap to use in many places.
  • getScrollPosition reads the current position once, without tracking.
Edit this page