JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10617
  • Score
    100M100P100Q147920F
  • License MIT

React component to calculate the size of browser scrollbars

Package Exports

  • react-scrollbar-size

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-scrollbar-size) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React-Scrollbar-Size

React-Scrollbar-Size is a React component designed to calculate the size of the user agent's horizontal and vertical scrollbars. It will also detect when the size of the scrollbars changes, such as when the user agent's zoom factor changes.

Installation

React-Scrollbar-Size is available as an npm package:

$ npm install --save react-scrollbar-size

Usage

Props

Name Description
onLoad Callback which will fire when the component mounts.
onChange Callback which will fire when the scrollbar sizes change.

Each of the callbacks accepts an object which will be updated with the following properties:

Name Description
scrollbarWidth The current width of the vertical scrollbar.
scrollbarHeight The current height of the horizontal scrollbar.

Example

import React, { Component } from 'react';
import ScrollbarSize from 'react-scrollbar-size';

class MyComponent extends Component {
  scrollbarSizeLoad = (measurements) => {
    console.log('Scrollbars loaded', measurements);
  }

  scrollbarSizeChange = (measurements) => {
    console.log('Scrollbars changed', measurements);
  }

  render() {
    return (
      <div>
        <ScrollbarSize
          onLoad={this.scrollbarSizeLoad}
          onChange={this.scrollbarSizeChange}
        />
      </div>
    );
  }
}

To see a live example, follow these instructions.

License

This project is licensed under the terms of the MIT license.