0.0.2 • Published 5 months ago

react-slide-switch v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

React Component Slider

A React component for creating smooth sliding transitions between components. Perfect for tabs, carousels, and any UI that requires horizontal sliding animations.

Installation

npm install react-slide-switch
# or
yarn add react-slide-switch
# or
pnpm add react-slide-switch
#or
bun add react-slide-switch

Usage

import { ComponentSlider } from 'react-slide-switch';

function App() {
  const [position, setPosition] = useState(0);
  
  return (
    <ComponentSlider
      position={position}
      duration={500}
      transition="ease-in-out"
      autoHeight
    >
      <div>First slide</div>
      <div>Second slide</div>
      <div>Third slide</div>
    </ComponentSlider>
  );
}

Props

PropTypeDefaultDescription
positionnumberrequiredCurrent slide position (0-based index)
childrenReactNode[]requiredArray of components to slide between
durationnumber500Animation duration in milliseconds
transitionstring"ease-linear"CSS transition timing function
unMountOnExitbooleanfalseWhether to unmount hidden slides
autoHeightbooleanfalseWhether to automatically adjust height
minHeightnumber | stringundefinedMinimum height of the slider
classNamestring""Additional CSS classes

Features

  • Smooth sliding transitions
  • Auto height adjustment
  • Customizable animation duration and timing
  • Optional unmounting of hidden slides
  • TypeScript support
  • Zero dependencies (except React)

Running Tests

To run the tests for this project, you can use the following command:

npm test

This will execute the tests using Jest. Make sure to install the dependencies first by running npm install. If you want to add more tests, create a __tests__ directory and add your test files there.

License

MIT

0.0.2

5 months ago

0.0.1

5 months ago