Carousel

Displays a horizontal sequence of slides.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add Carousel

InteractionNative markup

Design sourceLinked component node

See it in context

Preview

Dashboard

Portfolio

Storefront

Copy a working example

Usage

---
import {
  Button,
  Carousel
} from '@santi020k/lumen-astro'
---

<Carousel aria-label="Featured templates">
  <div data-ui-carousel-viewport>
    <article>Dashboard</article>
    <article>Portfolio</article>
    <article>Storefront</article>
  </div>
  <footer>
    <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
    <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
  </footer>
</Carousel>

---
import {
  Button,
  Carousel
} from '@santi020k/lumen-astro'
---

<Carousel aria-label="Featured templates">
  <div data-ui-carousel-viewport>
    <article>Dashboard</article>
    <article>Portfolio</article>
    <article>Storefront</article>
  </div>
  <footer>
    <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
    <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
  </footer>
</Carousel>

import { Button, Carousel } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <Carousel aria-label="Featured templates">
      <div data-ui-carousel-viewport>
        <article>Dashboard</article>
        <article>Portfolio</article>
        <article>Storefront</article>
      </div>
      <footer>
        <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
        <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
      </footer>
    </Carousel>
  </>
)

import { Button, Carousel } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <Carousel aria-label="Featured templates">
      <div data-ui-carousel-viewport>
        <article>Dashboard</article>
        <article>Portfolio</article>
        <article>Storefront</article>
      </div>
      <footer>
        <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
        <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
      </footer>
    </Carousel>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-carousel aria-label="Featured templates">
  <div data-ui-carousel-viewport>
    <article>Dashboard</article>
    <article>Portfolio</article>
    <article>Storefront</article>
  </div>
  <footer>
    <lumen-button size="sm" variant="outline" data-ui-carousel-prev>Previous</lumen-button>
    <lumen-button size="sm" variant="outline" data-ui-carousel-next>Next</lumen-button>
  </footer>
</lumen-carousel>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-carousel aria-label="Featured templates">
  <div data-ui-carousel-viewport>
    <article>Dashboard</article>
    <article>Portfolio</article>
    <article>Storefront</article>
  </div>
  <footer>
    <lumen-button size="sm" variant="outline" data-ui-carousel-prev>Previous</lumen-button>
    <lumen-button size="sm" variant="outline" data-ui-carousel-next>Next</lumen-button>
  </footer>
</lumen-carousel>

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

pnpm add @santi020k/lumen-astro

pnpm add @santi020k/lumen-astro

lumen add Carousel

lumen add Carousel

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add Carousel --target react

lumen add Carousel --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add Carousel --target elements

lumen add Carousel --target elements

Glass

Add the glass prop to apply the shared blur, saturation, border, and highlight tokens. Glass reads best over vivid content, so place the surface above imagery or color.

Astro surfaces

Standalone CSS, zero config.

React adapters

Same classes, JSX ergonomics.

Elements attributes

Web Components with glass attributes.

---
import { Button, Carousel } from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo">
  <Carousel aria-label="Glass releases" glass>
    <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
    <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
    <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
    <footer>
      <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
      <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
    </footer>
  </Carousel>
</div>

---
import { Button, Carousel } from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo">
  <Carousel aria-label="Glass releases" glass>
    <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
    <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
    <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
    <footer>
      <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
      <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
    </footer>
  </Carousel>
</div>

import { Button, Carousel } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo">
      <Carousel aria-label="Glass releases" glass>
        <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
        <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
        <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
        <footer>
          <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
          <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
        </footer>
      </Carousel>
    </div>
  </>
)

import { Button, Carousel } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo">
      <Carousel aria-label="Glass releases" glass>
        <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
        <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
        <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
        <footer>
          <Button size="sm" variant="outline" data-ui-carousel-prev>Previous</Button>
          <Button size="sm" variant="outline" data-ui-carousel-next>Next</Button>
        </footer>
      </Carousel>
    </div>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo">
  <lumen-carousel aria-label="Glass releases" glass>
    <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
    <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
    <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
    <footer>
      <lumen-button size="sm" variant="outline" data-ui-carousel-prev>Previous</lumen-button>
      <lumen-button size="sm" variant="outline" data-ui-carousel-next>Next</lumen-button>
    </footer>
  </lumen-carousel>
</div>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo">
  <lumen-carousel aria-label="Glass releases" glass>
    <article><strong>Astro surfaces</strong><p>Standalone CSS, zero config.</p></article>
    <article><strong>React adapters</strong><p>Same classes, JSX ergonomics.</p></article>
    <article><strong>Elements attributes</strong><p>Web Components with glass attributes.</p></article>
    <footer>
      <lumen-button size="sm" variant="outline" data-ui-carousel-prev>Previous</lumen-button>
      <lumen-button size="sm" variant="outline" data-ui-carousel-next>Next</lumen-button>
    </footer>
  </lumen-carousel>
</div>

API reference

Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.

Attribute	Values	Default	Description
glass	boolean \| "subtle" \| "strong"	false	Applies the tokenized liquid-glass surface treatment with backdrop-filter fallbacks; "subtle" and "strong" adjust the fill intensity.
data-ui-carousel-viewport	boolean attribute	-	Marks the scrollable slide viewport.
data-ui-carousel-prev, data-ui-carousel-next	boolean attribute	-	Marks child controls that move the viewport backward or forward.
class, className	string	""	Merges custom classes with the generated ui-* root classes.
...native attributes	HTML attributes	-	Forwards standard attributes to the root element unless the component consumes them.