Scroll

Bindings for @solid-primitives/scroll.

ScrollPosition

type ScrollPosition = interface

member x: int
member y: int

createScrollPosition

let createScrollPosition(
    ?element: #HtmlElement | Accessor<#HtmlElement>
    ): Accessor<ScrollPosition>

The target defaults to window.

useWindowScrollPosition

let useWindowScrollPosition(): ScrollPosition

A reactive window scroll position. Its signals and listeners are shared by every caller, so it is cheap to use in many places.

getScrollPosition

let getScrollPosition(): ScrollPosition

Reads the current position once, without tracking.