Interface IUseInViewportProps

Hierarchy

Properties

destroyOnIn? isDisabled? onIn? onOut? ref root? rootMargin? threshold?

Properties

Optional destroyOnIn

destroyOnIn?: boolean

If true, destroys the observer instance when the element appears in the viewport

Optional isDisabled

isDisabled?: boolean

If true, disables the intersection observer.

Default

false

Optional onIn

onIn?: (() => void)

Type declaration

    • (): void

    • Callback triggered when the element enters the viewport

      Returns void

Optional onOut

onOut?: (() => void)

Type declaration

    • (): void

    • Callback triggered when the element exits the viewport

      Returns void

ref

ref: THookEventElement<Element>

Observable element

Optional root

root?: null | Document | Element

The root element used for the intersection calculation.

Default

null

Optional rootMargin

rootMargin?: string

The margin around the root.

Default

'0px 0px 0px 0px'

Optional threshold

threshold?: number | number[]

The threshold(s) at which to trigger the callback.

Default

0

Settings

Member Visibility

Theme

On This Page