Skip to content

A custom scrollbar built for web

License

Notifications You must be signed in to change notification settings

alpheustangs/scrolia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Scrolia

A custom scrollbar built for web.

It currently supports various Chromium-based browsers, including Chrome, Edge, and Opera. It is disabled on all mobile browsers by detecting the user agent. Additional browser support may be added in the future based on demand or preference.

Major Frameworks like React/Next(both App Router and Page Router) and React Native are supported. More frameworks may be supported in the future if needed or desired.

The library is currently closed-source, but this may change in the future.

Installation

To use Scrolia via CDN, add the following script to the project:

<script src="https://unpkg.com/@scrolia/vanilla@X.X.X/dist/scrolia.js"></script>

To install Scrolia without any framework:

npm i @scrolia/vanilla

To install Scrolia for React:

npm i @scrolia/react

To install Scrolia for React Native Web:

npm i @scrolia/react-native

Usage

For using Scrolia through CDN, visit docs/vanilla/cdn.md.

For using Scrolia without any framework, visit docs/vanilla/import.md.

For using Scrolia in React, visit docs/react.md.

For using Scrolia in React Native Web, visit docs/react-native.md.

License

This project is MIT licensed, you can find the license file here.