TOScrollBar is a powerful library for adding customizable scrollbars to your web applications. It offers a simple and lightweight solution to enhance the usability and aesthetics of scrolling elements. This documentation will guide you through the process of installing the library, understanding its features, and implementing it in your projects.

TOScrollBar comes with a range of features that allow you to customize the behavior and appearance of scrollbars. Some of its key features include:

  • Customizable scrollbar styles
  • Smooth scrolling animation
  • Mouse wheel and touchpad support
  • Keyboard navigation
  • Responsive design
  • Auto hide and show scrollbars
  • Scroll event callbacks
  • Compatibility with major web browsers

To install TOScrollBar, follow these steps:

  1. Download the latest version of the library from the official GitHub repository.
  2. Extract the downloaded ZIP file to your project directory.
  3. Include the ‘toscrollbar.min.js’ file in your HTML file, preferably before the closing body tag.
  4. Include the ‘toscrollbar.min.css’ file in your HTML file, preferably in the head section.

To use TOScrollBar, follow these steps:

  1. Identify the element or container to which you want to apply the scrollbar.
  2. Add the ‘toscrollbar’ class to the element or container.
  3. Ensure that the element or container has a set height or max-height property to trigger the scrollbar when the content exceeds it.
  4. Optionally, you can modify the scrollbar style and behavior by using the available data attributes.

TOScrollBar offers various customization options to tailor the scrollbar’s appearance and behavior according to your preferences. The following data attributes can be used to modify the scrollbar:

  • data-scrollbar-color: Specifies the color of the scrollbar thumb.
  • data-scrollbar-width: Sets the width of the scrollbar thumb.
  • data-scrollbar-radius: Controls the rounded corner radius of the scrollbar thumb.
  • data-scrollbar-track-color: Defines the color of the scrollbar track.
  • data-scrollbar-track-width: Sets the width of the scrollbar track.
  • data-scrollbar-track-radius: Controls the rounded corner radius of the scrollbar track.
  • data-scrollbar-autohide: Enables or disables the auto hide feature for the scrollbar.
  • data-scrollbar-animate-duration: Specifies the duration of the scroll animation in milliseconds.

Here’s an example of applying the customization options:

<div class="toscrollbar" data-scrollbar-color="#ff0000" data-scrollbar-width="8px" data-scrollbar-animate-duration="500">

TOScrollBar is compatible with the following web browsers:

  • Google Chrome
  • Mozilla Firefox
  • Apple Safari
  • Microsoft Edge
  • Internet Explorer 11 (partial support)

Congratulations! You have successfully learned how to integrate TOScrollBar into your web applications. Enjoy the enhanced scrolling experience and feel free to experiment with different customization options to suit your project’s needs.