# @igloo-ui/carousel

> A carousel allows users to see and navigate the steps within a flow.

Latest version **0.5.0** (published 2026-03-24) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2026-03-24 |
| First published | 2023-01-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 22.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Officevibe Inc. |
| Maintainers | infra.admin, alexasselin008 |

## Links

- npm: https://www.npmjs.com/package/@igloo-ui/carousel
- Repository: https://github.com/workleap/ov-igloo-ui
- Homepage: https://github.com/workleap/ov-igloo-ui#readme
- Issues: https://github.com/workleap/ov-igloo-ui/issues
- npm.io page: https://npm.io/package/@igloo-ui/carousel

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.3.2
- [@igloo-ui/tokens](https://npm.io/package/@igloo-ui/tokens.md) ^2.1.0
- [@hopper-ui/tokens](https://npm.io/package/@hopper-ui/tokens.md) ^5.0.0

## Recent versions

- 0.5.0 (latest) — 2026-03-24
- 0.4.1 — 2026-03-11
- 0.4.0 — 2025-07-22
- 0.3.7 — 2024-09-18
- 0.3.6 — 2024-08-01
- 0.3.5 — 2024-05-17
- 0.3.4 — 2024-05-02
- 0.3.3 — 2024-04-10
- 0.3.2 — 2024-02-23
- 0.3.1 — 2024-02-06
- 0.3.0 — 2024-01-23
- 0.2.4 — 2024-01-10
- 0.2.3 — 2023-12-19
- 0.2.2 — 2023-12-11
- 0.2.1 — 2023-11-10
- … 6 more at https://npm.io/package/@igloo-ui/carousel/versions

## README

# Carousel

A carousel allows users to see and navigate the steps within a flow.

<Example is="custom" />

<ReferenceLinks is="custom" />

## Installation

To install `@igloo-ui/carousel` in your project, you will need to run the following command using [npm](https://www.npmjs.com/):

```bash
npm install @igloo-ui/carousel
```

If you prefer [Yarn](https://classic.yarnpkg.com/en/), use the following command instead:

```bash
yarn add @igloo-ui/carousel
```

## Usage

Then to use the component in your code just import it!

```jsx
import Button from '@igloo-ui/button';
import Carousel from '@igloo-ui/carousel';

const SLIDE_NUM = 3;
const [selected, setSelected] = React.useState(0);

const handlePageChange = (index) => {
  setSelected(index);
};

const handlePrimaryActionClick = () => {
  if (selected < SLIDE_NUM - 1) {
    handlePageChange(selected + 1);
  }
};

const handleSecondaryActionClick = () => {
  if (selected > 0) {
    handlePageChange(selected - 1);
  }
};

<Carousel
  onPageChange={handlePageChange}
  currentSlide={selected}
  primaryAction={
    <Button appearance={'primary'} onClick={handlePrimaryActionClick}>
      {selected < SLIDE_NUM - 1 ? 'Next' : 'Done'}
    </Button>
  }
  secondaryAction={
    <Button appearance={'secondary'} onClick={handleSecondaryActionClick}>
      {selected > 0 ? 'Prev' : 'Cancel'}
    </Button>
  }
>
  <div style={{ background: 'pink', padding: '4rem' }}>Slide 1</div>
  <div style={{ background: 'lightBlue', padding: '4rem' }}>Slide 2</div>
  <div style={{ background: 'lightGreen', padding: '4rem' }}>Slide 3</div>
</Carousel>;
```

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