# @livelybone/scroll-get

> Some useful tool of browser scroll, such as tool for calculating position relative to page/client, tool for getting the native scrollbar width...

Latest version **6.2.1** (published 2021-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @livelybone/scroll-get
pnpm add @livelybone/scroll-get
yarn add @livelybone/scroll-get
bun add @livelybone/scroll-get
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.2.1 |
| Published | 2021-06-27 |
| First published | 2018-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 31.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | 2631541504@qq.com |
| Maintainers | livelybone |
| Keywords | clientLeft, clientTop, pageLeft, pageTop, scrollbar width, scrollbar info |

## Links

- npm: https://www.npmjs.com/package/@livelybone/scroll-get
- Repository: https://github.com/livelybone/scroll-get
- Homepage: https://github.com/livelybone/scroll-get#readme
- Issues: https://github.com/livelybone/scroll-get/issues
- npm.io page: https://npm.io/package/@livelybone/scroll-get

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 6.2.1 (latest) — 2021-06-27
- 6.0.1 (alpha) — 2021-04-28
- 6.2.0 — 2021-06-27
- 6.1.2 — 2021-05-27
- 6.1.1 — 2021-05-27
- 6.1.0 — 2021-05-27
- 6.0.3 — 2021-05-27
- 6.0.2 — 2021-05-25
- 6.0.0 — 2021-04-28
- 5.0.2 — 2020-02-06
- 5.0.1 — 2020-02-06
- 5.0.0 — 2020-02-06
- 4.0.1 — 2019-12-02
- 4.0.0 — 2019-11-20
- 3.4.2 — 2019-07-28
- … 14 more at https://npm.io/package/@livelybone/scroll-get/versions

## README

# @livelybone/scroll-get
[![NPM Version](http://img.shields.io/npm/v/@livelybone/scroll-get.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/scroll-get)
[![Download Month](http://img.shields.io/npm/dm/@livelybone/scroll-get.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/scroll-get)
![gzip with dependencies: kb](https://img.shields.io/badge/gzip--with--dependencies-kb-brightgreen.svg "gzip with dependencies: kb")
![typescript](https://img.shields.io/badge/typescript-supported-blue.svg "typescript")
![pkg.module](https://img.shields.io/badge/pkg.module-supported-blue.svg "pkg.module")

> `pkg.module supported`, which means that you can apply tree-shaking in you project

[中文文档](./README-CN.md)

Some useful tool of browser scroll, such as tool for calculating position relative to page/client, tool for getting the native scrollbar width...

## repository
https://github.com/livelybone/scroll-get.git

## Demo
https://github.com/livelybone/scroll-get#readme

## Run Example
Your can see the usage by run the example of the module, here is the step:

1. Clone the library `git clone https://github.com/livelybone/scroll-get.git`
2. Go to the directory `cd your-module-directory`
3. Install npm dependencies `npm i`(use taobao registry: `npm i --registry=http://registry.npm.taobao.org`)
4. Open service `npm run dev`
5. See the example(usually is `http://127.0.0.1/examples/test.html`) in your browser

## Installation
```bash
npm i -S @livelybone/scroll-get
```

## Global name - The variable the module exported in `umd` bundle
`ScrollGet`

## Interface
See what method or params you can use in [index.d.ts](./index.d.ts)

## Usage
```js
import {
  getRect, 
  posRelativeToPage, 
  posRelativeToClient, 
  getNativeScrollbarWidth,
  animation,
  scrollToElement,
} from '@livleybone/scroll-get'

/**
 * @result DOMRect | ClientRect | TextRectangle
 * */
var rect = getRect(document.getElementById('id'))
/**
 * @result { pageLeft: Number, pageTop: Number }
 * */
var pos = posRelativeToPage(document.getElementById('id'))
/**
 * @result { clientLeft: Number, clientTop: Number }
 * */
var pos1 = posRelativeToClient(document.getElementById('id'))
/**
 * @param { undefined | Window | Element } el
 * @result { x: Number, y: Number }
 * */
var el = window
var scrollbarInfo = getNativeScrollbarWidth(el)
``` 

Use in html, see what your can use in [CDN: unpkg](https://unpkg.com/@livelybone/scroll-get/lib/umd/)
```html
<-- use what you want -->
<script src="https://unpkg.com/@livelybone/scroll-get/lib/umd/<--module-->.js"></script>
```

---
_Source: https://npm.io/package/@livelybone/scroll-get · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._