README.md

React Micro Carousel

Links

• Examples & Documentation
• NPM

Features

• Extremely small package size (gzipped):
  • Javascript: 2.6kB
  • CSS: 1.5kB
• 0 external dependencies
• Full typescript support
• Built in with Tailwind, but you can always customize the styles
• Handling touch/mouse events
• Lazy image loading
• Responsive support

How to use

Main Tailwind 4.x:

globals.css

@source "../node_modules/react-micro-carousel/dist";

Legacy Tailwind 3.x:

tailwind.config.ts

export default {
  content: [
    "./src/**/*.{js,ts,jsx,tsx}",
    "./node_modules/react-micro-carousel/**/*.js",
  ],
} satisfies Config;

Vanilla css (prebuild for Tailwind 4)

import 'react-micro-carousel/styles.min.css';

Components markup

import {
  Carousel,
  CarouselProvider,
  Counter,
  DotsGroup,
  NextButton,
  PrevButton,
  Slide,
} from 'react-micro-carousel';

<CarouselProvider slideHeight={200} total={2}>
  <Carousel>
    <Slide index={0}>
      <img src="..." />
    </Slide>
    <Slide index={1}>
      <img src="..." />
    </Slide>
  </Carousel>

  <DotsGroup />
  <NextButton>Next</NextButton>
  <PrevButton>Prev</PrevButton>
</CarouselProvider>;

Props documentation

<CarouselProvider />

Component is used to initialize the carousel context with configuration options and wrap the other components.

Prop	Type	Default	Required
children	ReactNode		Yes
slideHeight	number	0	Yes
total	number	0	Yes
autoPlayDelay	number	false	No
slidesVisible	number	1	No
step	number	1	No
threshold	number	0.25	No
infinite	boolean	false	No
disableTouch	boolean	false	No
lazy	boolean	true	No
autoPlay	boolean	false	No

<Carousel />

A carousel that wraps the slides and provides the core functionality, such as scrolling to the next or previous slide.

Prop	Type	Default	Required
children	ReactNode		Yes
wrapperClassName	string		No
carouselClassName	string		No

<Slide />

A single slide in a carousel.

Prop	Type	Default	Required
children	ReactNode		Yes
index	number		Yes
className	string		No

<Dot />

A single dot.

Prop	Type	Default	Required
className	string		No
colorActive	string		No
colorInactive	string		No
index	number		Yes
disabled	boolean		No
onClick	Function		No

<DotsGroup />

A component that renders a group of dots, representing the slides in the carousel. It provides auto generated dots for the carousel.

Prop	Type	Default	Required
className	string		No
dotClassName	string		No
colorActive	string		No
colorInactive	string		No
onClick	Function		No

<NextButton />

Prop	Type	Default	Required
className	string		No
children	ReactNode		Yes
onClick	Function		No

<PrevButton />

Prop	Type	Default	Required
className	string		No
children	ReactNode		Yes
onClick	Function		No

<Counter />

Prop	Type	Default	Required
className	string		No