Back to Vuetify

Scroll directive

packages/docs/src/pages/en/directives/scroll.md

4.1.41.2 KB
Original Source

Scroll directive

The v-scroll directive allows you to provide callbacks when the window, specified target or element itself (with .self modifier) is scrolled.

<PageFeatures /> <PromotedEntry /> <!-- ## Usage The default behavior is to bind to the window. If no additional configuration options are needed, you can simply pass your callback function. <ExamplesExample file="v-scroll/usage" /> -->

API

DirectiveDescription
v-scrollThe scroll directive
<ApiInline hide-links />

Examples

Options

Self

v-scroll targets the window by default but can also watch the element it's being bound to. In the following example we use the self modifier, v-scroll.self, to watch the v-card element specifically. This causes the method onScroll to invoke as you scroll the card contents; incrementing the counter.

<ExamplesExample file="v-scroll/option-self" />

Target

For a more fine tuned approach, you can designate the target to bind the scroll event listener.

<ExamplesExample file="v-scroll/option-target" />