# varun-ui-library

> Varun UI Library is a lightweight React component for creating vertical carousels in your web applications. It allows you to easily implement a vertical carousel with customizable options such as offset radius, animation configuration, and gesture support

Latest version **2.0.0** (published 2024-04-01) · 0 weekly downloads

## Install

```sh
npm install varun-ui-library
pnpm add varun-ui-library
yarn add varun-ui-library
bun add varun-ui-library
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2024-04-01 |
| First published | 2024-04-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 709.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | varun266 |

## Links

- npm: https://www.npmjs.com/package/varun-ui-library
- npm.io page: https://npm.io/package/varun-ui-library

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-with-gesture](https://npm.io/package/react-with-gesture.md) ^4.0.8
- [react-spring-3d-carousel](https://npm.io/package/react-spring-3d-carousel.md) ^1.3.4

## Recent versions

- 2.0.0 (latest) — 2024-04-01
- 1.3.0 — 2024-04-01
- 1.2.4 — 2024-04-01
- 1.2.3 — 2024-04-01
- 1.2.2 — 2024-04-01
- 1.2.1 — 2024-04-01
- 1.2.0 — 2024-04-01
- 1.1.9 — 2024-04-01
- 1.1.8 — 2024-04-01
- 1.1.7 — 2024-04-01
- 1.1.6 — 2024-04-01
- 1.1.5 — 2024-04-01
- 1.1.4 — 2024-04-01
- 1.1.3 — 2024-04-01
- 1.1.2 — 2024-04-01
- … 13 more at https://npm.io/package/varun-ui-library/versions

## README

# Varun UI Library

Varun UI Library is a lightweight React component for creating vertical carousels in your web applications. It allows you to easily implement a vertical carousel with customizable options such as offset radius, animation configuration, and gesture support.

## Installation

You can install Varun UI Library via npm:

```bash
npm install varun-ui-library
```

## Usage

```javascript
import React from 'react';
import ReactDOM from 'react-dom';
import CarouselContainer from 'varun-ui-library';
import 'varun-ui-library/dist/style.css';

const slides = [
  { key: 1, content: 'Slide 1' },
  { key: 2, content: 'Slide 2' },
  { key: 3, content: 'Slide 3' },
  { key: 4, content: 'Slide 4' },
  { key: 5, content: 'Slide 5' },
  { key: 6, content: 'Slide 6' },
  // Add more slides here
];

ReactDOM.render(
  <CarouselContainer slides={slides} />,
  document.getElementById('root')
);
```

## Props

- `slides`: An array of slide objects with unique keys and content.
- `offsetRadius` (optional): The offset radius for the carousel (default is 2).
- `animationConfig` (optional): Configuration object for animation (default is { tension: 120, friction: 14 }).

## Examples

![Example Image](./dist/carousel1.jpg)


## Contributing

Contributions are welcome! If you encounter any bugs or have suggestions for improvements, please open an issue or submit a pull request on the [GitHub repository] .

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Feel free to customize this README further to include additional information or instructions specific to your package.

---
_Source: https://npm.io/package/varun-ui-library · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._