useScrollIntoView

sensors

test coverage

Last changed: 17 days ago

Hook that provides functionality to scroll an element into view

typescript

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

Usage

typescript

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

Name	Type	Default	Note
target	HookTarget	-	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

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

debabin