# @pongo-ui/react-carousel

> An carousel component used to display a collection of images.

Latest version **0.0.4** (published 2022-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pongo-ui/react-carousel
pnpm add @pongo-ui/react-carousel
yarn add @pongo-ui/react-carousel
bun add @pongo-ui/react-carousel
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2022-03-28 |
| First published | 2022-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 111.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | pongobuild, czearing |

## Links

- npm: https://www.npmjs.com/package/@pongo-ui/react-carousel
- Repository: https://github.com/PongoAI/pongo-ui
- Homepage: https://github.com/PongoAI/pongo-ui#readme
- Issues: https://github.com/PongoAI/pongo-ui/issues
- npm.io page: https://npm.io/package/@pongo-ui/react-carousel

## Dependencies (5)

- [@griffel/react](https://npm.io/package/@griffel/react.md) ^1.0.0
- [@pongo-ui/react-icon](https://npm.io/package/@pongo-ui/react-icon.md) ^0.1.13
- [@pongo-ui/react-radio](https://npm.io/package/@pongo-ui/react-radio.md) ^0.0.10
- [@pongo-ui/react-theme](https://npm.io/package/@pongo-ui/react-theme.md) ^0.0.13
- [@fluentui/react-utilities](https://npm.io/package/@fluentui/react-utilities.md) ^9.0.0-rc.5

## Recent versions

- 0.0.4 (latest) — 2022-03-28
- 0.0.3 — 2022-03-28
- 0.0.2 — 2022-03-25
- 0.0.1 — 2022-03-24

## README

# Carousel

The Carousel component is used to display a collection of images.

## Use

1. Install the @pongo-ui/react-carousel component.

Using NPM

```
npm install @pongo-ui/react-carousel
```

Using Yarn

```
yarn add @pongo-ui/react-carousel
```

2. Install the @pongo-ui/react-provider and our theme tokens from @pongo-ui/react-theme

3. Set up the provider in your app:

```jsx
import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
    <Provider>
  )
}
```

4. Integrate the Carousel component.

```jsx
import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'
import { Carousel } from '@pongo-ui/react-carousel'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
        <Carousel>
          <img src='...'/>
        </Carousel>
    <Provider>
  )
}
```

## API

To learn more about the Carousel API take a look at the [Carousel Interface](src/components/Carousel/Carousel.types.ts) file.

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