scroll dom node into view automatically
Package: dom-scroll-into-view
Created by: yiminghe
Last modified: Tue, 07 Nov 2023 05:03:28 GMT
Version: 2.0.1
License: MIT
Downloads: 1,403,609
Repository: https://github.com/yiminghe/dom-scroll-into-view
Install
npm install dom-scroll-into-view
yarn add dom-scroll-into-view
dom-scroll-into-view
scroll node in contain to make node visible
install
Usage
import scrollIntoView from 'dom-scroll-into-view';
scrollIntoView(source,container,config);
Development
npm install
npm start
Example
http://localhost:8000/examples/
online example: http://yiminghe.github.io/dom-scroll-into-view/
function parameter
| name | type | default | description |
|---|---|---|---|
| source | HTMLElement | node wanted to show | |
| container | HTMLElement | ||
| config.alignWithLeft | Boolean | whether align with left edge | |
| config.alignWithTop | Boolean | whether align with top edge | |
| config.offsetTop | Number | ||
| config.offsetLeft | Number | ||
| config.offsetBottom | Number | ||
| config.offsetRight | Number | ||
| config.allowHorizontalScroll | Boolean | whether allow horizontal scroll container | |
| config.onlyScrollIfNeeded | Boolean | whether scroll container when source is visible |
License
dom-scroll-into-view is released under the MIT license.
Dependencies
@pika/plugin-build-node: 0.6.x@pika/plugin-build-types: 0.6.xpika-plugin-build-web-babel: ^0.6.0@pika/plugin-standard-pkg: 0.6.x@pika/types: 0.6.x@storybook/react: ^5.1.9@storybook/storybook-deployer: ^2.8.1babel-loader: ^8.0.6jquery: ^3.4.1lint-staged: ^9.2.1pre-commit: 1.xprettier: ^1.18.2react: 16.xreact-dom: 16.x
