react-overflow-slider v1.0.3
React Overflow Slider
A lightweight, high-performance, and responsive horizontal slider for React that works smoothly across devices, including mobile touch and MacBook touchpads. It leverages native CSS overflow-x: auto for buttery-smooth scrolling, while providing custom navigation buttons for seamless user interaction.
š Links
- š¦ View on NPM
- š» GitHub Repository
- š Live Demo
⨠Features
- š Smooth and Native Scrolling ā No JS calculations during scroll, even on touch devices.
- šÆ Customizable ā Add your own navigation buttons and styles.
- š± Responsive Design ā Fully adapts to different screen sizes.
- š„ Supports Any Content ā Text, images, or custom HTML elements.
- ā” Zero Lag ā Perfect for mobile swipes and MacBook touchpads.
š¦ Installation
Using npm
npm install react-overflow-slider
Using yarn
yarn add react-overflow-slider
Using pnpm
pnpm add react-overflow-slider
š Quick Start
import { OverflowSlider } from 'react-overflow-slider';
import 'react-overflow-slider/dist/index.css'; // Import styles for the slider
const Example = () => {
return (
<OverflowSlider>
<div>Slide 1</div>
<div>Slide 2</div>
<div>Slide 3</div>
</OverflowSlider>
);
};
āļø Props
Prop | Type | Default | Description |
---|---|---|---|
children | ReactNode[] | ā | Required. Child elements to display inside the slider. |
prevButton | ReactNode | ā | Custom "Previous" button. |
nextButton | ReactNode | ā | Custom "Next" button. |
gap | number \| string | 0 | Gap between elements inside the slider. You can use a number (for pixel values) or a CSS string (e.g., '4px', '1em') for the value. |
duration | number | 300 | Scroll animation duration in milliseconds. |
š Examples
š¤ Text Slider
A simple text slider with dynamic tag sizes.
ā ļø Note: When using fonts with fractional widths, rounding issues may occur, causing scroll glitches. For consistent behavior across platforms, use universal fonts (e.g., system-native fonts, sans-serif).
š” Tip: To use custom fonts while avoiding these issues, apply a transparent sans-serif font to set the correct element width, and overlay your desired font using absolute positioning. This way, the invisible font defines the size, while the visible text uses the custom font.
https://github.com/iscars/react-overflow-slider/tree/main/src/examples/tag-slider
š¼ļø Image Slider
A clean image slider for showcasing images.
https://github.com/iscars/react-overflow-slider/tree/main/src/examples/image-slider
š Card Slider
A slider to showcase cards with titles and descriptions.
https://github.com/iscars/react-overflow-slider/tree/main/src/examples/card-slider
š ļø Development
To begin local development:
- Clone the repo:
git clone https://github.com/iscars/react-overflow-slider.git
- Install dependencies:
pnpm install
- Run the project:
pnpm dev
š License
This project is licensed under the MIT License.
Feel free to use, modify, and distribute it as per the license terms. š¤