useScrollTo

sensors

test coverage

Last changed: last month

Hook for scrolling to a specific element

import { useScrollTo } from '@siberiacancode/reactuse';

Usage

const trigger = useScrollTo(ref, options);
// or
const { ref, trigger } = useScrollTo(options);

Demo

source

Api

Parameters

Name	Type	Default	Note
target	HookTarget	-	The target element for scrolling to
options?	UseScrollToOptions	-	The scroll options

Returns

UseScrollToReturn

Parameters

Name	Type	Default	Note
options?	UseScrollToOptions	-	The scroll options

Returns

UseScrollToReturn & { ref: StateRef<Target> }

Source

Source • Demo

Contributors

debabin

zeroqs