Carousel
A carousel component built with Embla, with optional previous/next controls and configurable orientation.
Preview
Loading...
import {
Carousel,
CarouselContent,
CarouselItem,
CarouselNext,
CarouselPrevious,
} from "@/components/ui/Carousel";
import { Card, CardContent } from "@/components/ui/Card";
export function CarouselDemo() {
return (
<Carousel className="w-full max-w-md mx-auto">
<CarouselContent>
{Array.from({ length: 5 }).map((_, index) => (
<CarouselItem key={index}>
<Card>
<CardContent className="flex aspect-square items-center justify-center p-2">
<span className="h1 font-semibold">{index + 1}</span>
</CardContent>
</Card>
</CarouselItem>
))}
</CarouselContent>
<CarouselPrevious />
<CarouselNext />
</Carousel>
);
}Installation
Make sure that namespace is set in your component.json file. Namespace docs: Learn more about namespaces
pnpm dlx shadcn@latest add @aura/carouselManual
Install the following dependencies:
pnpm install @radix-ui/react-iconsCopy and paste the button component into your components/ui/Button.tsx file.
/**
* @description Displays a button or a component that looks like a button.
*
* `mode` is a deprecated alias of `variant`. `variant="default"` is a
* deprecated alias of `fill`. Both still render and warn in development.
* Disabled chrome (opacity and cursor) lives only in `.button:disabled`.
* Loading sets `disabled` so the control stays non-interactive, and
* `data-loading` so it does not fade to the disabled opacity.
*/
import * as React from "react";
import { Slot } from "@radix-ui/react-slot";
import { cva, type VariantProps } from "class-variance-authority";
import { cn } from "@/utils/class-names";
import { Spinner } from "@/components/ui/Spinner";
const buttonVariants = cva(
"button focus-visible:[outline:var(--aura-outline)] [&_svg]:size-[1em]",
{
variants: {
variant: {
default: "button-fill",
fill: "button-fill",
pill: "button-pill border border-gray-6 text-gray-11 bg-gray-2 hover:bg-gray-3",
link: "button-link",
menu: "button-menu",
split: "button-fill button-split-action",
splitMenu: "button-fill button-split-menu",
},
size: {
default: "h-4",
xs: "h-2.5",
sm: "h-3",
md: "h-4",
lg: "h-5",
xl: "h-6",
// `icon` and `icon-sm` are the 39px (3 × 13px) icon button. `icon-md` is 52px.
icon: "w-3 h-3 p-0",
"icon-sm": "w-3 h-3 p-0",
"icon-md": "w-4 h-4 p-0",
},
},
defaultVariants: {
variant: "fill",
size: "default",
},
},
);
interface ButtonProps
extends React.ComponentProps<"button">,
VariantProps<typeof buttonVariants> {
asChild?: boolean;
isDisabled?: boolean;
isLoading?: boolean;
isLoadingText?: string | React.ReactNode;
/** @deprecated Use `variant`. Still applied, and warns in development. */
mode?: VariantProps<typeof buttonVariants>["variant"];
label?: string | React.ReactNode;
}
const deprecationWarnings = new Set<string>();
function warnOnce(message: string) {
if (process.env.NODE_ENV === "production") return;
if (deprecationWarnings.has(message)) return;
deprecationWarnings.add(message);
console.warn(message);
}
function resolveButtonContent(
label: React.ReactNode,
children: React.ReactNode,
): React.ReactNode {
const hasLabel = label != null && label !== false;
const hasChildren = children != null && children !== false;
if (hasLabel && hasChildren) {
warnOnce(
"Button: `label` and `children` both set the visible text. Pass one. `children` is shown.",
);
return children;
}
return hasChildren ? children : label;
}
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
(props: ButtonProps, ref) => {
const {
className,
variant,
mode,
size,
asChild = false,
isDisabled,
isLoading,
isLoadingText,
children,
label,
disabled: disabledProp,
...rest
} = props;
const Comp = asChild ? Slot : "button";
const explicitlyDisabled = Boolean(isDisabled || disabledProp);
const loading = Boolean(isLoading);
const nonInteractive = explicitlyDisabled || loading;
const effectiveVariant = variant ?? mode;
if (mode !== undefined) {
warnOnce(
"Button: `mode` is deprecated and duplicates `variant`. Pass `variant` instead. `mode` still works.",
);
}
if (variant === "default" || mode === "default") {
warnOnce(
'Button: variant "default" is deprecated and matches "fill". Pass `variant="fill"`. "default" still works.',
);
}
const content = resolveButtonContent(label, children);
return (
<Comp
data-slot="button"
className={cn(
buttonVariants({ variant: effectiveVariant, size, className }),
)}
ref={ref}
{...rest}
data-loading={loading && !explicitlyDisabled ? true : undefined}
aria-busy={loading ? true : undefined}
disabled={nonInteractive}
>
{asChild ? (
children
) : (
<>
{isLoading && isLoadingText ? (
isLoadingText
) : (
<>
{isLoading ? <Spinner /> : null}
{content}
</>
)}
</>
)}
</Comp>
);
},
);
Button.displayName = "Button";
export { Button, buttonVariants };
export type { ButtonProps };
export default Button;
Copy and paste the class names utility into your utils/class-names.ts file.
import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs))
}
Copy and paste the Carousel component into your components/ui/Carousel.tsx file.
"use client"
import * as React from "react"
import useEmblaCarousel, {
type UseEmblaCarouselType,
} from "embla-carousel-react"
import { cn } from "@/utils/class-names"
import { Button } from "@/components/ui/Button"
import { ChevronLeftIcon, ChevronRightIcon } from "@radix-ui/react-icons"
type CarouselApi = UseEmblaCarouselType[1]
type UseCarouselParameters = Parameters<typeof useEmblaCarousel>
type CarouselOptions = UseCarouselParameters[0]
type CarouselPlugin = UseCarouselParameters[1]
type CarouselProps = {
opts?: CarouselOptions
plugins?: CarouselPlugin
orientation?: "horizontal" | "vertical"
setApi?: (api: CarouselApi) => void
}
type CarouselContextProps = {
carouselRef: ReturnType<typeof useEmblaCarousel>[0]
api: ReturnType<typeof useEmblaCarousel>[1]
scrollPrev: () => void
scrollNext: () => void
canScrollPrev: boolean
canScrollNext: boolean
} & CarouselProps
const CarouselContext = React.createContext<CarouselContextProps | null>(null)
function useCarousel() {
const context = React.useContext(CarouselContext)
if (!context) {
throw new Error("useCarousel must be used within a <Carousel />")
}
return context
}
function Carousel({
orientation = "horizontal",
opts,
setApi,
plugins,
className,
children,
...props
}: React.ComponentProps<"div"> & CarouselProps) {
const [carouselRef, api] = useEmblaCarousel(
{
...opts,
axis: orientation === "horizontal" ? "x" : "y",
},
plugins
)
const [canScrollPrev, setCanScrollPrev] = React.useState(false)
const [canScrollNext, setCanScrollNext] = React.useState(false)
const onSelect = React.useCallback((api: CarouselApi) => {
if (!api) return
setCanScrollPrev(api.canScrollPrev())
setCanScrollNext(api.canScrollNext())
}, [])
const scrollPrev = React.useCallback(() => {
api?.scrollPrev()
}, [api])
const scrollNext = React.useCallback(() => {
api?.scrollNext()
}, [api])
const handleKeyDown = React.useCallback(
(event: React.KeyboardEvent<HTMLDivElement>) => {
const prevKey = orientation === "vertical" ? "ArrowUp" : "ArrowLeft"
const nextKey = orientation === "vertical" ? "ArrowDown" : "ArrowRight"
if (event.key === prevKey) {
event.preventDefault()
scrollPrev()
} else if (event.key === nextKey) {
event.preventDefault()
scrollNext()
}
},
[orientation, scrollPrev, scrollNext]
)
React.useEffect(() => {
if (!api || !setApi) return
setApi(api)
}, [api, setApi])
React.useEffect(() => {
if (!api) return
onSelect(api)
api.on("reInit", onSelect)
api.on("select", onSelect)
return () => {
api?.off("select", onSelect)
api?.off("reInit", onSelect)
}
}, [api, onSelect])
return (
<CarouselContext.Provider
value={{
carouselRef,
api: api,
opts,
orientation:
orientation || (opts?.axis === "y" ? "vertical" : "horizontal"),
scrollPrev,
scrollNext,
canScrollPrev,
canScrollNext,
}}
>
<div
onKeyDownCapture={handleKeyDown}
className={cn(
"relative",
orientation === "horizontal" &&
"max-sm:flex max-sm:flex-wrap max-sm:items-center max-sm:justify-center max-sm:gap-1",
className
)}
role="region"
aria-roledescription="carousel"
data-slot="carousel"
{...props}
>
{children}
</div>
</CarouselContext.Provider>
)
}
function CarouselContent({ className, ...props }: React.ComponentProps<"div">) {
const { carouselRef, orientation } = useCarousel()
return (
<div
ref={carouselRef}
className={cn(
"overflow-hidden",
orientation === "horizontal" && "max-sm:order-1 max-sm:basis-full max-sm:min-w-0"
)}
data-slot="carousel-content"
>
<div
className={cn(
"flex",
orientation === "horizontal" ? "-ml-1" : "-mt-1 flex-col",
className
)}
{...props}
/>
</div>
)
}
function CarouselItem({ className, ...props }: React.ComponentProps<"div">) {
const { orientation } = useCarousel()
return (
<div
role="group"
aria-roledescription="slide"
data-slot="carousel-item"
className={cn(
"min-w-0 shrink-0 grow-0 basis-full",
orientation === "horizontal" ? "pl-1" : "pt-1",
className
)}
{...props}
/>
)
}
function CarouselPrevious({
className,
variant = "pill",
size = "icon",
...props
}: React.ComponentProps<typeof Button>) {
const { orientation, scrollPrev, canScrollPrev } = useCarousel()
return (
<Button
data-slot="carousel-previous"
variant={variant}
size={size}
className={cn(
"rounded-full touch-manipulation",
orientation === "horizontal"
? "max-sm:static max-sm:order-2 max-sm:shrink-0 sm:absolute sm:top-1/2 sm:-left-12 sm:-translate-y-1/2"
: "absolute -top-12 left-1/2 -translate-x-1/2 rotate-90",
className
)}
disabled={!canScrollPrev}
onClick={scrollPrev}
{...props}
>
<ChevronLeftIcon className="icon cn-rtl-flip" />
<span className="sr-only">Previous slide</span>
</Button>
)
}
function CarouselNext({
className,
variant = "pill",
size = "icon",
...props
}: React.ComponentProps<typeof Button>) {
const { orientation, scrollNext, canScrollNext } = useCarousel()
return (
<Button
data-slot="carousel-next"
variant={variant}
size={size}
className={cn(
"rounded-full touch-manipulation",
orientation === "horizontal"
? "max-sm:static max-sm:order-2 max-sm:shrink-0 sm:absolute sm:top-1/2 sm:-right-12 sm:-translate-y-1/2"
: "absolute -bottom-12 left-1/2 -translate-x-1/2 rotate-90",
className
)}
disabled={!canScrollNext}
onClick={scrollNext}
{...props}
>
<ChevronRightIcon className="icon cn-rtl-flip" />
<span className="sr-only">Next slide</span>
</Button>
)
}
export {
type CarouselApi,
Carousel,
CarouselContent,
CarouselItem,
CarouselPrevious,
CarouselNext,
useCarousel,
}
Usage
MultipleCards
Loading...
import {
Carousel,
CarouselContent,
CarouselItem,
CarouselNext,
CarouselPrevious,
} from "@/components/ui/Carousel";
import {
Card,
CardContent,
CardDescription,
CardHeader,
CardTitle,
} from "@/components/ui/Card";
export const MultipleCards = () => {
const slides = [
{ title: "Mountain View", description: "Scenic landscape" },
{ title: "Workspace", description: "Modern office setup" },
{ title: "Technology", description: "Digital innovation" },
{ title: "Ocean", description: "Coastal views" },
{ title: "City", description: "Urban nights" },
];
return (
<Carousel opts={{ align: "start" }} className="w-full">
<CarouselContent>
{slides.map((slide, index) => (
<CarouselItem
key={slide.title}
className="basis-full sm:basis-1/2 md:basis-1/3"
>
<Card className="flex h-full min-h-13 flex-col">
<CardHeader>
<CardTitle>{slide.title}</CardTitle>
<CardDescription>{slide.description}</CardDescription>
</CardHeader>
<CardContent className="flex flex-1 items-center justify-center">
<p className="text-gray-12">Slide {index + 1}</p>
</CardContent>
</Card>
</CarouselItem>
))}
</CarouselContent>
<CarouselPrevious />
<CarouselNext />
</Carousel>
);
};