useScrollIntoView

Category

Sensors

Hook that provides functionality to scroll an element into view

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

Usage

const { trigger } = useScrollIntoView(ref);
// or
const { ref, trigger } = useScrollIntoView<HTMLDivElement>();

Demo

source

Api

Parameters

Name	Type	Default	Note
target	Target	-	The target element to scroll into view
options.behavior?	ScrollBehavior	'smooth'	The scrolling behavior
options.block?	ScrollLogicalPosition	'start'	The vertical alignment
options.inline?	ScrollLogicalPosition	'nearest'	The horizontal alignment

Returns

UseScrollIntoViewReturn

Parameters

Name	Type	Default	Note
options.behavior?	ScrollBehavior	'smooth'	The scrolling behavior
options.block?	ScrollLogicalPosition	'start'	The vertical alignment
options.inline?	ScrollLogicalPosition	'nearest'	The horizontal alignment

Returns

UseScrollIntoViewReturn & { ref: StateRef<Target> }

Contributors

Source • Demo