🌗 React component for custom overlay-scrollbars with native scrolling mechanism.
  • JavaScript 88.1%
  • Shell 11.9%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Travis Ralston 9cf17f63b7
Merge pull request #3 from matrix-org/travis/bump
Bump version of package
2019-09-17 10:50:29 -06:00
dist re-add dist/index.js 2019-08-01 13:28:52 +01:00
scripts add / AUTHORS 2016-07-06 20:20:03 -05:00
src Use create-react-class instead of React.createClass to support react16 2019-08-01 13:27:51 +01:00
.babelrc Added babel-cli and friends to devDependencies, then rebuilt dist/index.js 2016-07-06 11:54:00 +10:00
.gitignore Update: changed prepublish to dist and added the compiled files to github. 2015-05-07 18:39:43 -05:00
AUTHORS add / AUTHORS 2016-07-06 20:20:03 -05:00
CHANGELOG.md 2.1.5 2016-07-05 21:17:49 -05:00
CONTRIBUTING.md add / contributing 2015-06-25 23:15:34 -05:00
LICENSE Rename license to LICENSE 2015-05-08 21:25:35 -05:00
package.json Bump correctly 2019-09-17 10:27:06 -06:00
README.md update / badge styles 2016-06-14 22:20:06 -05:00

react-gemini-scrollbar

npm-image license-image

React component for creating custom overlay-scrollbars with native scrolling mechanism for web applications (when needed)

Important:

  • It only create the custom scrollbars (bind events, etc) when the OS does not supports “overlay-scrollbars” natively, otherwise leave the scrollbars intact
  • IE9+ support

Uses gemini-scrollbar under the hood, check the gemini-scrollbar repo for more information.

Install

NPM

npm install react-gemini-scrollbar --save

Usage

JSX

var GeminiScrollbar = require('react-gemini-scrollbar');

<GeminiScrollbar>
    <h1>The content.<h1>
    <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>
</GeminiScrollbar>

Don’t forget the gemini stylesheet

NPM@2 located at:

node_modules/react-gemini-scrollbar/node_modules/gemini-scrollbar/gemini-scrollbar.css

NPM@3 located at:

node_modules/gemini-scrollbar/gemini-scrollbar.css

Props

  • autoshow: show scrollbars upon hovering
  • forceGemini: add option to force Gemini scrollbars even if native overlay-scrollbars are available

Customization

You can change the styles of the scrollbars using CSS. Ex:

/* override gemini-scrollbar default styles */

/* vertical scrollbar track */
.gm-scrollbar.-vertical {
  background-color: #f0f0f0
}

/* horizontal scrollbar track */
.gm-scrollbar.-horizontal {
  background-color: transparent;
}

/* scrollbar thumb */
.gm-scrollbar .thumb {
  background-color: rebeccapurple;
}
.gm-scrollbar .thumb:hover {
  background-color: fuchsia;
}

If you want to specify different scrollbar styles for your components, one alternative is to pass a className to the component. Then you can use that className as a namespace when writing your css. Ex:

<GeminiScrollbar className='my-awesome-scrollbar'>...</GeminiScrollbar>
.my-awesome-scrollbar .gm-scrollbar.-vertical {...}
.my-awesome-scrollbar .gm-scrollbar.-horizontal {...}
.my-awesome-scrollbar .gm-scrollbar .thumb {...}

License

MIT © Noel Delgado