SimpleBar

SimpleBar is a plugin that tries to solve a long time problem : how to get custom scrollbars for your web-app? SimpleBar does NOT implement a custom scroll behaviour. It keeps the native overflow: auto scroll and only replace the scrollbar visual appearance.

SimpleBar is meant to be as easy to use as possible and lightweight. If you want something more advanced I recommend https://github.com/noraesae/perfect-scrollbar

Installation

- Via npm npm install simplebar --save

Then don't forget to import both css and js in your project.

- Via <script> tag

<link rel="stylesheet" href="https://unpkg.com/simplebar@latest/dist/simplebar.css" />
<script src="https://unpkg.com/simplebar@latest/dist/simplebar.js"></script>
<!-- or -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/simplebar@latest/dist/simplebar.css">
<script src="https://cdn.jsdelivr.net/npm/simplebar@latest/dist/simplebar.js"></script>

note: you can replace @latest to the latest version (ex @2.4.3), if you want to lock to a specific version

- For Ruby On Rails

To include SimpleBar in the Ruby On Rails asset pipeline, use the simplebar-rails gem.

Usage

If you are using a module loader you first need to load SimpleBar: import 'SimpleBar'; or import SimpleBar from 'SimpleBar';

Set data-simplebar on the element you want your custom scrollbar. You're done.

<div data-simplebar></div>

⚠️ Warning!

SimpleBar is not intended to be used on the body element! I don't recommend wrapping your entire web page inside a custom scroll as it will often affect badly the user experience (slower scroll performances compare to native body scroll, no native scroll behaviours like click on track, etc.). Do it at your own risk! SimpleBar is meant to improve the experience of internal web pages scroll: like a chat box or a small scrolling area.

Troubleshoot

If you are experiencing issues when setting up SimpleBar it is most likely because your styles are clashing with SimpleBar ones. Make sure the element you are setting SimpleBar on does not override any SimpleBar css properties! We recommend to not style at all that element and use an inner element instead.

Documentation
Browsers support
Demo
How it works
Changelog
Credits

1. Documentation

Other usages

You can start SimpleBar mannually if you need to:

new SimpleBar(document.getElementById('myElement'))

If you want to use jQuery:

new SimpleBar($('#myElement')[0])

Options

Options can be applied to the plugin during initialization:

new SimpleBar(document.getElementById('myElement'), {
    option1: value1,
    option2: value2
})

or using data-attributes:

<div data-simplebar data-simplebar-auto-hide="false">

Available options are:

autoHide

By default SimpleBar automatically hides the scrollbar if the user is not scrolling (it emulates Mac OSX Lion's scrollbar). You can make the scrollbar always visible by setting the autoHide option to false:

new SimpleBar(document.getElementById('myElement'), { autoHide: false });

Default value is true

You can also control the animation via CSS as it's a simple CSS opacity transition.

scrollbarMinSize

Define the minimum scrollbar size in pixels.

Default value is 10

classNames

It is possible to change the default class names that SimpleBar uses. To get your own styles to work refer to simplebar.css to get an idea how to setup your css.

content represents the wrapper for the content being scrolled.
scrollContent represents the container containing elements being scrolled.
scrollbar defines the style of the scrollbar with which the user can interact to scroll the content.
track styles the area surrounding the scrollbar.

classNames: {
  // defaults
  content: 'simplebar-content',
  scrollContent: 'simplebar-scroll-content',
  scrollbar: 'simplebar-scrollbar',
  track: 'simplebar-track'
}

Notifying the plugin of content changes

Note: you shouldn't need to use these functions as SimpleBar is taking care of that automatically. This is for advanced usage only.

If you later dynamically modify your content, for instance changing its height or width, or adding or removing content, you should recalculate the scrollbars like so:

var el = new SimpleBar(document.getElementById('myElement'));
el.recalculate()

Trigger programmatical scrolling

If you want to access to original scroll element, you can retrieve it via a getter :

var el = new SimpleBar(document.getElementById('myElement'));
el.getScrollElement()

Subscribe to `scroll` event

You can subscribe to the scroll event just like you do with native scrolling element :

var el = new SimpleBar(document.getElementById('myElement'));
el.getScrollElement().addEventListener('scroll', function(...));

Add content dynamically (ajax)

You can retrieve the element containing datas like this :

var el = new SimpleBar(document.getElementById('myElement'));
el.getContentElement();

Disable Mutation Observer

SimpleBar.removeObserver();

Non-JS fallback

SimpleBar hides the browser's default scrollbars, which obviously is undesirable if the user has JavaScript disabled. To restore the browser's scrollbars you can include the following noscript element in your document's head:

<noscript>
  <style>
    [data-simplebar] {
      overflow: auto;
    }
  </style>
</noscript>

2. Browsers support

Simplebar has been tested on the following browsers: Chrome, Firefox, Safari, Edge, IE11.

Notice: IE10 doesn't support MutationObserver so you will still need to instantiate SimpleBar manually and call recalculate() as needed (or you can just use a polyfill for MutationObserver).

If you want to support IE9 or apply SimpleBar on an SVG element on IE11, you will need a polyfill for classList.

Or you can use SimpleBar v1.

3. Demo

http://grsmto.github.io/simplebar/

4. How it works

SimpleBar does only one thing : replace the browser's default scrollbars with a custom CSS-styled scrollbar without losing performance. Unlike most of others plugins, SimpleBar doesn't mimic scroll with Javascript, causing janks and strange scrolling behaviours...You keep the awesomeness of native scrolling...with a custom scrollbar! Design your scrollbar like you want, with CSS, on all browsers.

For the most part SimpleBar uses the browser's native scrolling functionality, but replaces the conventional scrollbar with a custom CSS-styled scrollbar. The plugin listens for scroll events and redraws the custom scrollbar accordingly.

Key to this technique is hiding the native browser scrollbar. The scrollable element is made slightly wider/taller than its containing element, effectively hiding the scrollbar from view.

5. Changelog

See changelog here : https://github.com/Grsmto/simplebar/releases

6. Credits

Most of the credit goes to Jonathan Nicol who made the original plugin called Trackpad Scroll Emulator.

Website: http://html5up.net/

Additional contributors

Yoh Suzuki: wrapContent option

moyus / simplebar Goto Github PK

simplebar's Introduction