# @app-elements/carousel

> Simple carousel with arrows and dot indicators.

Latest version **2.0.2** (published 2020-11-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install @app-elements/carousel
pnpm add @app-elements/carousel
yarn add @app-elements/carousel
bun add @app-elements/carousel
```

## 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.2 |
| Published | 2020-11-04 |
| First published | 2018-10-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 94.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Input Logic Team |
| Maintainers | coryschadt, trustfall, adriaanwm, staydecent |
| Keywords | react, react-component, preact, component, ui |

## Links

- npm: https://www.npmjs.com/package/@app-elements/carousel
- Repository: https://github.com/inputlogic/elements
- Homepage: https://github.com/inputlogic/elements#readme
- Issues: https://github.com/inputlogic/elements/issues
- npm.io page: https://npm.io/package/@app-elements/carousel

## Dependencies (1)

- [@app-elements/level](https://npm.io/package/@app-elements/level.md) ^2.0.1

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 2.0.2 (latest) — 2020-11-04
- 2.0.1 — 2020-06-24
- 2.0.0 — 2020-06-24
- 2.0.0-alpha.0 — 2020-06-23
- 1.2.3 — 2020-03-12
- 1.2.2 — 2020-01-28
- 1.2.1 — 2019-11-15
- 1.2.0 — 2019-10-16
- 1.1.3 — 2019-09-18
- 1.1.2 — 2019-08-08
- 1.1.1 — 2019-03-07
- 1.1.0 — 2019-02-27
- 1.0.5 — 2019-02-27
- 1.0.4 — 2019-02-08
- 1.0.3 — 2018-11-21
- … 2 more at https://npm.io/package/@app-elements/carousel/versions

## README

# Carousel

Simple (P)React carousel with arrows and dot indicators.

## Installation

`npm install --save @app-elements/carousel`

## Usage

```javascript
import Carousel from '@app-elements/carousel'

const items = ['fff', 'a7c', '09d', '411', '111']

<Carousel withDots>
  {items.map(hex => (
    <Image
      src={`http://www.placehold.it/400x300/${hex}/f44?text=${hex}`}
      unloadedSrc={`http://www.placehold.it/400x300/eee/eee?text=Loading`}
      style='width: 100%'
    />
  ))}
</Carousel>
```

## Props

| Prop                   | Type       | Default       | Description         |
|------------------------|------------|------------|---------------------|
| **`className`**        | _String_   | `'carousel-slide'` | className given to each slide element.
| **`wrapperClass`**     | _String_   | `''`               | className given to top-level carousel div.
| **`noNav`**            | _Boolean_  | `false`            | Set to `true` to skip rendering prev/next elements.
| **`withDots`**         | _Boolean_  | `false`            | If `true`, renders indicator dots below slides.
| **`active`**           | _Number_   | `0`                | The active slide, must be an index of one of the children.
| **`tolerance`**        | _Number_   | `100`              | Tolerance for detecting touch swipes.
| **`children`**         | _Array_    | _None_             | Each child is one of the slides in the Carousel.

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