astro-carousel

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

★ 64 Open GitHub ↗

Accessible carousel component for Astro🎠

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# astro-carousel 🎠

An accessible carousel component for Astro 🚀 that works by using browser navigation.

Demo with code: https://stackblitz.com/edit/astro-carousel-demo?file=src%2Fcomponents%2FWelcome.astro

Live example: https://kuraunaito.com/photos/saint-malo/?image=0

![Screenshot of astro-carousel open in a website](https://a.storyblok.com/f/95455/2560x1600/8bdc66d7ea/screenshot-2024-04-26-at-13-42-02.png/m/1280x0)

# Installation

```bash
npm install astro-carousel
```

Also, `sass` needs to be installed a dev dependency:

```bash
npm install --save-dev sass
```

# Usage

Import astro-carousel to your Astro component

```js
---
import { Carousel } from 'astro-carousel';
---
...
```

To open the carousel from a list of images, you need to use `id="carouselTargetList"` in the parent element and `data-carousel-index={index}` in the anchor tag of children elements. You also need to set the `href` of the anchor tag to `` href={`${path}?image=${index}`} ``.

```js
<ul id="carouselTargetList">
  {images.map((img, index) => {
    return (
      <li>
        <a
          href={`/?image=${index}`}
          data-carousel-index={index}
        >
          <img
            src={img.src}
            alt=""
          />
        </a>
      </li>
    );
  })}
</ul>
```

After importing the Carousel component in your Astro component, you just need to create a list of images and pass it to the prop `images`.

```js
---
import Carousel from 'astro-carousel';
const images: ComponentProps<typeof Carousel>["images"] = [
  {
    src: "https://a.storyblok.com/f/95455/1350x1080/3ef7748922/p5240368.jpg",
    alt: "",
    format: "webp",
    width: 1350,
    height: 1080,
    widths: [450, 675, 1350],
  }
];
---

<Carousel images={images} />
```

The color of the buttons can be customized by passing the desired color in a CSS color valid format to the prop `color`.

```js
<Carousel
  images={images}
  color="hsl(239, 90%, 65%)"
/>
```

astro-carousel

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README