BlockDex

Components

Registries

Free blocks

Method

BlockDex

Components

Registries

Free blocks

Method

Open API

BlockDex

Components

Registries

Free blocks

Method

Open API

Components/blok/carousel

Carousel

blok/carousel
FreeComponent

A carousel component for displaying a series of items in a sliding manner.

Install it

npx shadcn@latest add https://blok.sitecore.com/r/carousel.json

Source

src/components/ui/carousel.tsxblok.sitecore.com/r/carousel.json
1"use client";
2
3import { Icon } from "@/lib/icon";
4import { mdiArrowLeft, mdiArrowRight } from "@mdi/js";
5import useEmblaCarousel, {
6 type UseEmblaCarouselType,
7} from "embla-carousel-react";
8import * as React from "react";
9
10import { Button } from "@/components/ui/button";
11import { cn } from "@/lib/utils";
12
13type CarouselApi = UseEmblaCarouselType[1];
14type UseCarouselParameters = Parameters<typeof useEmblaCarousel>;
15type CarouselOptions = UseCarouselParameters[0];
16type CarouselPlugin = UseCarouselParameters[1];
17
18type CarouselProps = {
19 opts?: CarouselOptions;
20 plugins?: CarouselPlugin;
21 orientation?: "horizontal" | "vertical";
22 setApi?: (api: CarouselApi) => void;
23};
24
25type CarouselContextProps = {
26 carouselRef: ReturnType<typeof useEmblaCarousel>[0];
27 api: ReturnType<typeof useEmblaCarousel>[1];
28 scrollPrev: () => void;
29 scrollNext: () => void;
30 canScrollPrev: boolean;
31 canScrollNext: boolean;
32} & CarouselProps;
33
34const CarouselContext = React.createContext<CarouselContextProps | null>(null);
35
36function useCarousel() {
37 const context = React.useContext(CarouselContext);
38
39 if (!context) {
40 throw new Error("useCarousel must be used within a <Carousel />");
41 }
42
43 return context;
44}
45
46function Carousel({
47 orientation = "horizontal",
48 opts,
49 setApi,
50 plugins,
51 className,
52 children,
53 ...props
54}: React.ComponentProps<"div"> & CarouselProps) {
55 const [carouselRef, api] = useEmblaCarousel(
56 {
57 ...opts,
58 axis: orientation === "horizontal" ? "x" : "y",
59 },
60 plugins,
61 );
62 const [canScrollPrev, setCanScrollPrev] = React.useState(false);
63 const [canScrollNext, setCanScrollNext] = React.useState(false);
64
65 const onSelect = React.useCallback((api: CarouselApi) => {
66 if (!api) return;
67 setCanScrollPrev(api.canScrollPrev());
68 setCanScrollNext(api.canScrollNext());
69 }, []);
70
71 const scrollPrev = React.useCallback(() => {
72 api?.scrollPrev();
73 }, [api]);
74
75 const scrollNext = React.useCallback(() => {
76 api?.scrollNext();
77 }, [api]);
78
79 const handleKeyDown = React.useCallback(
80 (event: React.KeyboardEvent<HTMLDivElement>) => {
81 if (event.key === "ArrowLeft") {
82 event.preventDefault();
83 scrollPrev();
84 } else if (event.key === "ArrowRight") {
85 event.preventDefault();
86 scrollNext();
87 }
88 },
89 [scrollPrev, scrollNext],
90 );
91
92 React.useEffect(() => {
93 if (!api || !setApi) return;
94 setApi(api);
95 }, [api, setApi]);
96
97 React.useEffect(() => {
98 if (!api) return;
99// … truncated

What it pulls in

npm packages

  • embla-carousel-react
  • @mdi/js

Other registry items

  • https://blok.sitecore.com/r/button.json
  • https://blok.sitecore.com/r/theme.json

Files it writes

  • src/components/ui/carousel.tsx
  • src/lib/icon.tsx

Facts

Registry
blok
Type
registry:ui
Access
Free
Files written
2
Licence
NOASSERTION
First indexed
2026-08-02
Last confirmed
today

Go to the source

blok.sitecore.com Sitecore/blok on GitHub Raw registry item This item as JSON

More from blok

All 72 items
Same registry, same kind — the ones you would have found next
ComponentRegistryKindAccessInstallsCommand
AccordionaccordionblokComponentsFree2 deps · 2 files
Action baraction-barblokComponentsFree1 dep · 2 files
AlertalertblokComponentsFree2 deps · 2 files
Alert dialogalert-dialogblokComponentsFree2 deps
Aspect ratioaspect-ratioblokComponentsFree1 dep
AvataravatarblokComponentsFree1 dep
BadgebadgeblokComponentsFree2 deps
All componentsblok-componentsblokComponentsFreeno deps
BlockDex

Built by

Kynth Studio

Index

Components
Registries
Method
Open API

Guides

shadcn component libraries
Best shadcn registries
Free shadcn blocks

Reference

Corpus counts
Crawl health
hello@kynth.studio
Privacy
Terms

BlockDex

BlockDex

Built by

Kynth Studio

Index

Components
Registries
Method
Open API

Guides

shadcn component libraries
Best shadcn registries
Free shadcn blocks

Reference

Corpus counts
Crawl health
hello@kynth.studio
Privacy
Terms

BlockDex

BlockDex

Built by

Kynth Studio

Index

Components
Registries
Method
Open API

Guides

shadcn component libraries
Best shadcn registries
Free shadcn blocks

Reference

Corpus counts
Crawl health
hello@kynth.studio
Privacy
Terms

BlockDex