A tool to get browser's scrollbars width. 

xobotyi

@xobotyi/scrollbar-width

## [1.9.3](https://github.com/xobotyi/scrollbar-width/compare/v1.9.2...v1.9.3) (2020-02-24)

* readme fix; ([35902e0](https://github.com/xobotyi/scrollbar-width/commit/35902e085f6007954b552ce96bde0c342a0b4a4e))

## [1.9.2](https://github.com/xobotyi/scrollbar-width/compare/v1.9.1...v1.9.2) (2020-02-24)

* add clarification about the cache as promised in issue [#2](https://github.com/xobotyi/scrollbar-width/issues/2); ([944436f](https://github.com/xobotyi/scrollbar-width/commit/944436f421d01abe1bc5c17cc6ebdefd9c9d97a7))

## [1.9.1](https://github.com/xobotyi/scrollbar-width/compare/v1.9.0...v1.9.1) (2020-02-24)

* adjusting document check for SSR ([bd68002](https://github.com/xobotyi/scrollbar-width/commit/bd68002f7b247d49a2af02342e927ef08328c998))

# [1.9.0](https://github.com/xobotyi/scrollbar-width/compare/v1.8.2...v1.9.0) (2020-02-16)

* added blank spaces after headings; ([99da435](https://github.com/xobotyi/scrollbar-width/commit/99da435376b7a91c284e1f4dc35eff02694383d5))

* lint-staged commands been using the tslint; ([72810b9](https://github.com/xobotyi/scrollbar-width/commit/72810b9c3b039198187b2067d482d37871555247))

* terser now minifies all the code via rollup plugin; ([3596475](https://github.com/xobotyi/scrollbar-width/commit/3596475b903d0523c960a011e946480718d11382))

## [1.8.2](https://github.com/xobotyi/scrollbar-width/compare/v1.8.1...v1.8.2) (2020-01-30)

* tweak the travis build (build missing in dist). ([77b4db3](https://github.com/xobotyi/scrollbar-width/commit/77b4db32180576e79f6c0a2d162cef25b627a0d6))

## [1.8.1](https://github.com/xobotyi/scrollbar-width/compare/v1.8.0...v1.8.1) (2020-01-30)

* make only `dist` directory appear in package. ([adf19e6](https://github.com/xobotyi/scrollbar-width/commit/adf19e6e0338becf94f7fe5972a9659721e6ee13))

# [1.8.0](https://github.com/xobotyi/scrollbar-width/compare/v1.7.0...v1.8.0) (2020-01-27)

* rework travis config; ([a4f7ff9](https://github.com/xobotyi/scrollbar-width/commit/a4f7ff92eda332051761becab28d0be39c1f8408))

# [1.7.0](https://github.com/xobotyi/scrollbar-width/compare/v1.6.1...v1.7.0) (2020-01-27)

* add weekly downloads badge; ([59647de](https://github.com/xobotyi/scrollbar-width/commit/59647de964f6f87936d61d7f876f518c8b1ff66a))

* add weekly downloads badge; ([da4a506](https://github.com/xobotyi/scrollbar-width/commit/da4a5063c02c93a72580627b843967071d2b185f))

## [1.6.1](https://github.com/xobotyi/scrollbar-width/compare/v1.6.0...v1.6.1) (2020-01-27)

* add root files to the linting process; ([48c7e3c](https://github.com/xobotyi/scrollbar-width/commit/48c7e3ce24f4adce1bc6411fece4084d7a0ead3f))

# [1.6.0](https://github.com/xobotyi/scrollbar-width/compare/v1.5.0...v1.6.0) (2020-01-27)

* TS config now does not conflicts with rollup ([564d523](https://github.com/xobotyi/scrollbar-width/commit/564d523f3f9b5d578cfcbc15b966b59dbda2dd0c))

* tweak eslint config and fix the code; ([456d726](https://github.com/xobotyi/scrollbar-width/commit/456d72636ded5833a18ab7d5d20e56c9dea120ef))

* get rid of .lock file - not needed here. ([d5415e2](https://github.com/xobotyi/scrollbar-width/commit/d5415e2053b3f2920891379e318a6654ed7171c3))

* Replace tslint with eslint ([e4f29a2](https://github.com/xobotyi/scrollbar-width/commit/e4f29a2f79b5c0d673c0cfdf7727915d2604c940))

# [1.5.0](https://github.com/xobotyi/scrollbar-width/compare/v1.4.1...v1.5.0) (2019-12-09)

* Add extra check of DOM readiness. ([0bf89ef](https://github.com/xobotyi/scrollbar-width/commit/0bf89efbf1344c772f5766f14fc60722c9c077a8))

## [1.4.1](https://github.com/xobotyi/scrollbar-width/compare/v1.4.0...v1.4.1) (2019-11-19)

* **coverage:** Fix codacy coverage push; ([b1545af](https://github.com/xobotyi/scrollbar-width/commit/b1545afa2c4c3c6d15fdd6404af5aa9e4d59f649))

# [1.4.0](https://github.com/xobotyi/scrollbar-width/compare/v1.3.0...v1.4.0) (2019-11-19)

* **tests:** Linux detection fix; ([be38927](https://github.com/xobotyi/scrollbar-width/commit/be389270341acd650bd1bd81885dfd027b0626fe))

* FireFox on linux have SBW of width 16 ([8d10f9b](https://github.com/xobotyi/scrollbar-width/commit/8d10f9b0fd2c1ce198484dbc94a27d0521e19aa2))

  "description": "A tool to get browser's scrollbars width.",

    "url": "https://github.com/xobotyi/scrollbar-width.git"

    "url": "https://github.com/xobotyi/scrollbar-width/issues"

  "homepage": "https://github.com/xobotyi/scrollbar-width",

    "@semantic-release/changelog": "^5.0.0",

    "@xobotyi/preset-typescript": "^1.0.0",

    "rollup-plugin-typescript2": "^0.26.0",

    "lint": "eslint ./{src,tests}/**/*.ts ./*.{ts,js}",

    "build": "rimraf dist && rollup --config",

    "semantic-release": "semantic-release"

      "pre-commit": "yarn lint:types && lint-staged",

      "pre-push": "yarn lint:fix && rimraf dist && yarn build && yarn test"

    <p>A tool to get browser's scrollbars width.</p>

    <p>×&nbsp;<strong><a href="https://codesandbox.io/s/xobotyiscrollbar-width-live-demo-bp5no">LIVE EXAMPLE</a></strong>&nbsp;×</p>

<div align="center">❤️Please consider starring this project to show your love and support.🙌</div>

This lib is written in TypeScript and delivered with both, transpiled and untranspiled ES versions:

- `main` field of package.json is pointing to transpiled ES5-compatible version with CJS modules resolution;

- `module` field is pointing to transpiled ES5-compatible version with ES modules resolution;

- `esnext` field is pointing to the ESnext version with ES modules resolution;

you can add it directly to your site via the `<script />` with help of [UNPKG](https://unpkg.com):

After that you will be able to use the function as `xobotyi.scrollbarWidth()`

import { scrollbarWidth } from '@xobotyi/scrollbar-width';

scrollbarWidth(); // for most browsers will return 17 and 0 for SSR environment

// or undefined if to call it too early [read below]

This function caches the value to avoid increased resources usage. In case you want to get re-calculated value - pass `true` as first call parameter.

>Function will return `undefined` in case being called before the DOM is ready.

This function has inner cache due to scrollbars width is not intended to be changed since initial call, but it can in case you toggle the device emulation.  

If you need function to recalculate the width, set `scrollbarWidth.__cache` to `undefined` and next call will perform return the fresh value.

If you need function to recalculate the width call it with `true` parameter and get new value or set `scrollbarWidth.__cache` to `undefined` and next call will return the fresh value.

- [react-scrollbars-custom](https://www.npmjs.com/package/react-scrollbars-custom) &mdash; The best React custom scrollbars component. Allows you to customise scrollbars as you like it, crossbrowser!

- [zoom-level](https://www.npmjs.com/package/zoom-level) &mdash; A comprehensive cross-browser package that allow you to determine page's and element's zoom level.

- [@xobotyi/should-reverse-rtl-scroll](https://www.npmjs.com/package/@xobotyi/should-reverse-rtl-scroll) &mdash; A tool detecting if RTL scroll value should be negative.

		{
		"name": "@xobotyi/scrollbar-width",
		"version": "1.9.2",
		"version": "1.9.3",
		"publishConfig": {
		@@ -5,0 +5,0 @@ "access": "public"

		@@ -0,1 +1,8 @@
		## [1.9.3](https://github.com/xobotyi/scrollbar-width/compare/v1.9.2...v1.9.3) (2020-02-24)


		### Bug Fixes

		* readme fix; ([35902e0](https://github.com/xobotyi/scrollbar-width/commit/35902e085f6007954b552ce96bde0c342a0b4a4e))

		## [1.9.2](https://github.com/xobotyi/scrollbar-width/compare/v1.9.1...v1.9.2) (2020-02-24)
		@@ -2,0 +9,0 @@

		@@ -74,3 +74,3 @@ <div align="center">
		This function has inner cache due to scrollbars width is not intended to be changed since initial call, but it can in case you toggle the device emulation.
		If you need function to recalculate the width, set `scrollbarWidth.__cache` to `undefined` and next call will perform return the fresh value.
		If you need function to recalculate the width call it with `true` parameter and get new value or set `scrollbarWidth.__cache` to `undefined` and next call will return the fresh value.

		@@ -77,0 +77,0 @@ ## Related projects

Improved metrics