@scrolia/react

A custom scrollbar component


Keywords
Scrolia, scrollbar, react, ts, TypeScript, js, JavaScript, react-native, web
License
MIT
Install
npm install @scrolia/react@0.2.2

Documentation

Scrolia

A custom scrollbar built for web.

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.

Installation

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

<script src="https://unpkg.com/@scrolia/vanilla@latest/dist/scrolia.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@scrolia/vanilla@latest/dist/index.css" />

For production, use the minified version:

<script src="https://unpkg.com/@scrolia/vanilla@latest/dist/scrolia.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@scrolia/vanilla@latest/dist/index.min.css" />

Install Scrolia as a dependency in pure JavaScript/TypeScript project:

# npm
npm i @scrolia/vanilla

# Yarn
yarn add @scrolia/vanilla

# pnpm
pnpm add @scrolia/vanilla

Install Scrolia as a dependency in React project:

# npm
npm i @scrolia/react

# Yarn
yarn add @scrolia/react

# pnpm
pnpm add @scrolia/react

Install Scrolia as a dependency in React Native project:

# npm
npm i @scrolia/react-native

# Yarn
yarn add @scrolia/react-native

# pnpm
pnpm add @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, visit docs/react-native.md.

License

This project is licensed under the terms of the MIT license.