---
url: "https://vueda.dev/v3/reference/api/js/use/useScrollReveal/types/ScrollRevealState.md"
title: "ScrollRevealState"
---

# ScrollRevealState

## Properties

### isIdle {#isIdle}

Whether scrolling has settled for at least `idleDelay` since the last scroll.

Type: `boolean`

Source: `client/lib/use/useScrollReveal.js:40`

### isPastThreshold {#isPastThreshold}

Whether the scroll position is past the element's original bottom edge (the chrome's spot has left the viewport).

Type: `boolean`

Source: `client/lib/use/useScrollReveal.js:39`

### isScrollingUp {#isScrollingUp}

Whether the most recent scroll moved toward the top.

Type: `boolean`

Source: `client/lib/use/useScrollReveal.js:38`

## Source

`client/lib/use/useScrollReveal.js:37`
