Carousel

import { CarouselDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.Carousel);

Installation

After installation import package styles at the root of your application:

import '@mantine/core/styles.css';
// ‼️ import carousel styles after core package styles
import '@mantine/carousel/styles.css';

Do not forget to import styles

Have you followed the installation instructions above but something is not working (Carousel slides are rendered vertically, no controls or indicators)? You've fallen into the trap of not importing carousel styles! To fix the issue, import carousel styles at the root of your application:

import '@mantine/carousel/styles.css';

Documentation demos

The demos presented on this page use blue background color for demonstration purposes. To simplify demo code, background color and other demo-only styles are not included in the demo code. When you copy and paste demo code to your project, it will not have blue background color.

Usage

@mantine/carousel package is based on embla carousel:

Options

Embla options

You can pass configuration options directly to embla carousel with the emblaOptions prop. You can find embla options description in the embla options reference.

Example of passing loop, dragFree and align options:

Size and gap

Set slideSize and slideGap on the Carousel component to control the size and gap of every slide:

Responsive styles

slideSize and slideGap props work the same way as style props, you can pass an object with values for different breakpoints:

Container queries

To use container queries instead of media queries, set type="container". With container queries, slide size and gap will be adjusted based on the container width, not the viewport width.

Note that when using container queries, slideSize and slideGap props cannot reference theme.breakpoints values in keys. You are required to use exact px or em values.

To see how the slide size and gap changes, resize the root element of the demo with the resize handle located at the bottom right corner of the demo:

Drag free

dragFree will disable slide snap points – users will be able to stop dragging at any position:

Vertical orientation

A carousel with orientation="vertical" requires the height prop to be set:

Controls icons

You can replace default next/previous controls icons with any React nodes:

100% height

Set height="100%" to make the Carousel take 100% height of the container. Note that in this case:

• the container element must have display: flex styles
• the carousel root element must have flex: 1 styles
• the container element must have fixed height

import { Carousel } from '@mantine/carousel';

export function PercentageHeight() {
  return (
    <div style={{ height: 400, display: 'flex' }}>
      <Carousel withIndicators height="100%" flex={1}>
        <Carousel.Slide>1</Carousel.Slide>
        <Carousel.Slide>2</Carousel.Slide>
        <Carousel.Slide>3</Carousel.Slide>
      </Carousel>
    </div>
  );
}

Get embla instance

You can get the embla instance with the getEmblaApi prop. You will be able to enhance the carousel with additional logic after that using embla api methods:

Embla plugins

Set the plugins prop to enhance the carousel with embla plugins. Note that plugins are not installed with the @mantine/carousel package and you will need to install them separately.

Example with autoplay plugin:

Indicator styles

Hide inactive controls

Show controls on hover

Example: Images carousel

Example: Cards carousel

Accessibility

Set aria-label or aria-labelledby on the Carousel component to make it accessible for screen readers:

import { Carousel } from '@mantine/carousel';

export function AccessibleCarousel() {
  return (
    <Carousel aria-label="Gallery of nature pictures">
      <Carousel.Slide>...</Carousel.Slide>
      <Carousel.Slide>...</Carousel.Slide>
      <Carousel.Slide>...</Carousel.Slide>
    </Carousel>
  );
}

Set aria-label for next/previous controls with nextControlProps and previousControlProps props:

import { Carousel } from '@mantine/carousel';

export function AccessibleControlsCarousel() {
  return (
    <Carousel
      aria-label="Gallery of nature pictures"
      nextControlProps={{ 'aria-label': 'Next slide' }}
      previousControlProps={{ 'aria-label': 'Previous slide' }}
    >
      <Carousel.Slide>...</Carousel.Slide>
      <Carousel.Slide>...</Carousel.Slide>
      <Carousel.Slide>...</Carousel.Slide>
    </Carousel>
  );
}