# @yonchando/carouseljs

> Carousel slide with easy config and responsive html.

Latest version **1.2.4** (published 2022-07-08) · MIT License license · 0 weekly downloads

## Install

```sh
npm install @yonchando/carouseljs
pnpm add @yonchando/carouseljs
yarn add @yonchando/carouseljs
bun add @yonchando/carouseljs
```

## 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.2.4 |
| Published | 2022-07-08 |
| First published | 2022-06-06 |
| Weekly downloads | 0 |
| License | MIT License |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 118.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yon Chando |
| Maintainers | yonchando |
| Keywords | carouseljs, jquery, javascript, slider |

## Links

- npm: https://www.npmjs.com/package/@yonchando/carouseljs
- Repository: https://github.com/yonchando/carouseljs
- Homepage: https://github.com/yonchando/carouseljs#readme
- Issues: https://github.com/yonchando/carouseljs/issues
- npm.io page: https://npm.io/package/@yonchando/carouseljs

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 1.2.4 (latest) — 2022-07-08
- 1.2.3 — 2022-06-20
- 1.2.2 — 2022-06-20
- 1.2.1 — 2022-06-20
- 1.2.0 — 2022-06-18
- 1.1.3 — 2022-06-07
- 1.1.2 — 2022-06-06
- 1.1.1 — 2022-06-06
- 1.1.0 — 2022-06-06
- 1.0.1 — 2022-06-06
- 1.0.0 — 2022-06-06

## README

## About Carousel
Carousel is the simple slider responsive.

## Installation

This carousel.js is required [jquery](https://jquery.com "jquery.com") package.<br>

> npm i @yonchando/carouseljs

## Usage Example

> HTML add style and css

You need to import css/js to your project file.

> Noted import jquery before carousel.js

```html

<html>
<head>
    <-- add carouseljs style -->
    <link rel="stylesheet" href="node_modules/@yonchando/carouseljs/dist/css/carousel.css">
</head>
<body>
<div class="carousel">
    <div>Your Items</div>
    <div>Your Items</div>
    <div>Your Items</div>
    ...
</div>

<-- add carouseljs js -->
<script src="node_modules/@yonchando/carouseljs/dist/css/carousel.js"></script>

<-- usage -->
<script>
    $('.carousel').carousel({
        items: 4,
    });
</script>
</body>
</html>
```

> Webpack

Import style to your scss file.

```scss
@import "node_modules/@yonchando/carouseljs";
```

Import js to your js file.

```javascript
require('@yonchando/carouseljs');
```

## Configs

| Config                | Description                                                                        | Default | Type   | Example                                                            |
|:----------------------|:-----------------------------------------------------------------------------------|:--------|--------|:-------------------------------------------------------------------|
| items                 | Show items to visible on screen                                                    | 4       | Number |                                                                    |
| slideBy               | Slide item by click on botton control left/right                                   | 1       | Number |                                                                    |
| carouselContentClass  | Add your custom class to contents                                                  |         | String |                                                                    |
| controlClass          | Add your custom class to control button                                            |         | String |                                                                    |
| btnClass              | Add your custom class to button control left and right                             |         | String |                                                                    |
| btnIcon               | Custom icons to button control left and right                                      |         | Array  | `['<i class= "btn-left"></i>','<i class="btn-right"></i>']`        |
| responsive            | Custom Responsive items show and slide by. Example `{breakpoint: {items,slideBy}}` |         | object | `{ 0: { items:1 }, 768: {items: 2}, 1280: {items: 4,slideBy: 4} }` |

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