@types/overlayscrollbars

What is @types/overlayscrollbars?

@types/overlayscrollbars provides TypeScript definitions for the OverlayScrollbars library, which is used to create customizable and performant scrollbars for web applications.

What are @types/overlayscrollbars's main functionalities?

Initialization

This feature allows you to initialize OverlayScrollbars on a specific DOM element. The second parameter is an options object where you can customize the scrollbar.

const osInstance = OverlayScrollbars(document.getElementById('myElement'), {});

Options Configuration

This feature allows you to configure various options such as theme and resize behavior when initializing OverlayScrollbars.

const osInstance = OverlayScrollbars(document.getElementById('myElement'), { className: 'os-theme-dark', resize: 'both' });

Methods

This feature allows you to use various methods provided by the OverlayScrollbars instance, such as scrolling to a specific position.

osInstance.scroll({ x: '100%', y: '100%' });

Events

This feature allows you to attach event listeners to the OverlayScrollbars instance, such as listening for scroll events.

osInstance.on('scroll', (event) => { console.log('Scrolled!', event); });

Other packages similar to @types/overlayscrollbars

simplebar

SimpleBar is a similar library that provides custom scrollbars with minimal styles. It is simpler to use but offers fewer customization options compared to OverlayScrollbars.

perfect-scrollbar

Perfect Scrollbar is another library for creating custom scrollbars. It focuses on providing a minimalistic scrollbar with good performance. It is less feature-rich compared to OverlayScrollbars but is easier to set up.

react-custom-scrollbars

React Custom Scrollbars is a library specifically designed for React applications. It provides customizable scrollbars with a focus on React's component-based architecture. It is more suitable for React projects compared to OverlayScrollbars.

README

Installation

npm install --save @types/overlayscrollbars

Summary

This package contains type definitions for overlayscrollbars (https://kingsora.github.io/OverlayScrollbars).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/overlayscrollbars.

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: none

Credits

These definitions were written by KingSora.