scrollbun
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

Scrollbun

Scrollbun is a lightweight and customizable React component that allow you effortlessly create horizontal scrolling container for your app.

cover gif image

Installation

To install dependencies:

npm install scrollbun
bun install scrollbun

Usage

Here's an example of usage:

import Scrollbun from 'scrollbun'

function App() {
  return (
    <Scrollbun style={{ width: '500px' }}>
      <div style={{ width: '500px', height: '300px' }} />
      <div style={{ width: '500px', height: '300px' }} />
    </Scrollbun>
  )
}

Props

Prop name Description Default value
direction Can be 'horizontal' or 'vertical'. 'horizontal'
scrollRate A number to control scroll rate. 0.5
...rest any HTMLDivElement prop, except onWheel, that will be added to the main div element. n/a

Contributors ✨


Olzh K. Kurikov

D. Sailaubek

LICENSE

MIT

This project was created using bun init in bun v1.0.0. Bun is a fast all-in-one JavaScript runtime.

Readme

Keywords

Package Sidebar

Install

npm i scrollbun

Weekly Downloads

3

Version

1.1.0

License

MIT

Unpacked Size

4.47 kB

Total Files

5

Last publish

Collaborators

  • olzh2102