2.3.0 • Published 6 years ago

react-scrollbar-size-v2 v2.3.0

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

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

NameDescription
onLoadCallback which will fire when the component mounts.
onChangeCallback which will fire when the scrollbar sizes change.

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

NameDescription
scrollbarWidthThe current width of the vertical scrollbar.
scrollbarHeightThe 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.