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

# ScrollRevealOptions

## Properties

### idleDelay {#idleDelay}

Milliseconds of scroll inactivity after which the `scroll-up-or-idle` strategy reveals the chrome. Defaults to 300.

Type: `number`

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

### reveal {#reveal}

The reveal strategy, or a boolean (revealed when `true`); pass a ref or getter of either to drive it reactively. Defaults to `scroll-up-or-idle`.

Type: `MaybeRefOrGetter`

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

### scrollRoot {#scrollRoot}

The scroll container the behavior reacts to. Pass the scrollable element (or a ref/getter to one) when the chrome lives inside a scrollable region; the hide/reveal threshold and the scroll listener bind to it. When nullish (the default) the behavior reacts to the window.

Type: `MaybeRefOrGetter`

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

## Source

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