v0.0.0v0.0.0
Source ↗Source ↗ (opens in a new tab)
GitHubGitHub (opens in a new tab)
  • Introduction
    • Installation
    • Usage
  • Components
    • Cascading Select
    • Cascading Select End-to-end 🔥
    • Checkbox
    • Color Picker
    • Date 🔥
    • Dynamic Fields 🔥
    • File
    • Input 🤖
    • Live Search
    • Multiple Checkboxes
    • Multiple Select 🔥
    • Native Select
    • Number Input
    • Radio
    • Range Slider
    • Search Bar
    • Select 🔥
    • Switch
    • Tag Input
    • Textarea 🤖
    • Accordion
    • Back To Top
    • Chatbox 🔥🤖
    • Digital Clock
    • Event Calendar 🔥
    • Event Calendar Timeline 🔥
    • Modal Dialog 🔥
    • Pagination
    • Show More Less
    • Stepper
    • Table 🔥
    • Tabs
    • Toast
    • Tooltip
    • Tree 🔥
    • Dropdown Menu
    • Multilevel Dropdown Menu
    • DragDrop List 🔥
    • Horizontal Scroll Content
    • Mode Switch
    • Refresher
    • Custom Scrollbar
    • Scroll Reveal
    • Masonry Layout
    • Root Portal
    • Splitter Panel
    • useKeyPress
    • useThrottle
    • useDebounce
    • useComId
    • useInterval
    • useWindowScroll
    • useAutosizeTextArea
    • useClickOutside
    • useDraggable
    • useBoundedDrag
    • useStreamController

On This Page

  • Usage
Question? Give us feedback → (opens in a new tab)

useWindowScroll

Listens for scrolls the window to a particular place in the document.

Usage

import useWindowScroll from 'funda-ui/Utils/useWindowScrollx';
 
const App = () => {
    const [scrollData, windowScrollUpdate] = useWindowScroll({
        performance: ['debounce', 500],   // "['debounce', 500]" or "['throttle', 500]"
        handle: (scrollData) => {
            // do something
            console.log(scrollData);
        }
    });
};
Installation

©2024 Funda UI