# carousal-hub

> An easy to use carousal component that turns everything it wraps into carousal items

Latest version **1.0.0** (published 2022-06-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install carousal-hub
pnpm add carousal-hub
yarn add carousal-hub
bun add carousal-hub
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-06-21 |
| First published | 2022-06-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 173.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Romeo.Dev |
| Maintainers | romeo-dot-dev |
| Keywords | react, bootstrap, carousal, responsive |

## Links

- npm: https://www.npmjs.com/package/carousal-hub
- Repository: https://github.com/Romeo60/Easy-Carousal
- Homepage: https://github.com/Romeo60/Easy-Carousal#readme
- Issues: https://github.com/Romeo60/Easy-Carousal/issues
- npm.io page: https://npm.io/package/carousal-hub

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^18.2.0
- [bootstrap](https://npm.io/package/bootstrap.md) ^5.1.3
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [react-icons](https://npm.io/package/react-icons.md) ^4.4.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-06-21

## README

# carousal-hub

An easy to use responsive react bootstrap carousal component. Basically turns everything it wraps into Carousal items, it's that 'Easy'



## Installation
```javascript
npm i carousal-hub
```

## Dependancies

The component if built with bootstrap and react-icons you should install them along with the package if they are not already installed in your project.

1. Bootstrap
```javascript
npm i bootstrap
```
2. React-Icons
```javascript
npm i react-icons
```



# Usage

## props

Takes two optional props to show hints/text, 'hint'will take a string of text show show a normal hint/text, 'boldHint' will also take a string of text and will output a <bold>bold</bold> hint/text.

```javascript
<EasyCarousal hint='Nornal text' boldHint='Bold text'>{children}</EasyCarousal>
```

### import package and wrap carousel items between EasyCarousal tags
```javascript
import EasyCarousal from 'carousal-hub';
// Anything wrapped bellow will be a carousal item eg images and divs and everything else

  <EasyCarousal hint='What are you' boldHint='here to do?'>
    <div className="items full-width text-center">
        <h1 className="product">1</h1>      
    </div>

    <div className="items full-width text-center">
        <h1 className="product">2</h1>      
    </div>

    <div className="items full-width text-center">
        <h1 className="product">3</h1>      
    </div>

    <div className="items full-width text-center">
        <h1 className="product">4</h1>      
    </div>

    <div className="items full-width text-center">
        <h1 className="product">5</h1>      
    </div>
  </EasyCarousal>

```

# Preview

![Alt text](https://i.imgur.com/MF3u2mS.png)

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