Demo

Installation

Get the latest version from NPM:

$ npm install astro-splide @splidejs/splide

Usage

Simple Example

Here is the astro code of a loop carousel, of 3 pictures, with 1 second interval.

---
import "@splidejs/splide/css"
import { Splide, SplideSlide } from 'astro-splide';
---
<Splide
  class='not-content'
  options={ {  // check for options at https://splidejs.com/guides/options/
    type: 'loop',         // type of the carousel
    autoplay: true,       // activate autoplay
    interval: 1000,       // autoplay interval in milliseconds
    pauseOnHover: false,  // do not pause autoplay on mouseover
  } }
>
  <SplideSlide>
    <img src='https://picsum.photos/1024/512?nb=1' alt=''/>
  </SplideSlide>
  <SplideSlide>
    <img src='https://picsum.photos/1024/512?nb=2' alt=''/>
  </SplideSlide>
  <SplideSlide>
    <img src='https://picsum.photos/1024/512?nb=3' alt=''/>
  </SplideSlide>
</Splide>

Components

Import Splide and SplideSlide components in frontmatter:

import { Splide, SplideSlide } from 'astro-splide';

...and render them like this:

<Splide aria-label="My Favorite Images">
  <SplideSlide>
    <img src="image1.jpg" alt="Image 1"/>
  </SplideSlide>
  <SplideSlide>
    <img src="image2.jpg" alt="Image 2"/>
  </SplideSlide>
</Splide>

If you have the visible heading for the carousel, use aria-labelledby instead of aria-label. See this page for more details.

CSS

Select a CSS file you want to use in frontmatter, and import it:

// Default theme
import '@splidejs/splide/css';

// or other themes
import '@splidejs/splide/css/skyblue';
import '@splidejs/splide/css/sea-green';

// or only core styles
import '@splidejs/splide/css/core';

Custom Structure

Although <Splide> renders a track element by default, you can handle them respectively with the hasTrack prop and the <SplideTrack> component. In a nutshell, following 2 components render the same HTML:

---
import { Splide, SplideTrack, SplideSlide } from 'astro-splide';
---
<Splide>
  <SplideSlide>...</SplideSlide>
</Splide>

<Splide hasTrack={ false }>
  <SplideTrack>
    <SplideSlide>...</SplideSlide>
  </SplideTrack>
</Splide>

Separating <SplideTrack> from <Splide> allows you to place arrows, pagination or other controls anywhere outside the track in the similar way of vanilla Splide. For example, Splide renders arrows before a track by default, but you are able to specify the location with a placeholder:

<Splide hasTrack={ false } aria-label="...">
  <div class="custom-wrapper">
    <SplideTrack>
      <SplideSlide>...</SplideSlide>
    </SplideTrack>

    <div class="splide__arrows" />
  </div>
</Splide>

...or with custom arrows:

<Splide hasTrack={ false } aria-label="...">
  <SplideTrack>
    <SplideSlide>...</SplideSlide>
  </SplideTrack>

  <div class="splide__arrows">
    <button class="splide__arrow splide__arrow--prev">Prev</button>
    <button class="splide__arrow splide__arrow--next">Next</button>
  </div>
</Splide>

In the same way, you can add an autoplay toggle button and progress bar like so:

<Splide hasTrack={ false } aria-label="...">
  <SplideTrack>
    <SplideSlide>...</SplideSlide>
  </SplideTrack>

  <div class="splide__progress">
    <div class="splide__progress__bar" />
  </div>

  <button class="splide__toggle" type="button">
 	  <span class="splide__toggle__play">Play</span>
 	  <span class="splide__toggle__pause">Pause</span>
  </button>
</Splide>

...or:

<Splide hasTrack={ false } aria-label="...">
  <div class="custom-wrapper">
    <button class="splide__toggle" type="button">
      <span class="splide__toggle__play">Play</span>
      <span class="splide__toggle__pause">Pause</span>
    </button>

    <div class="splide__progress">
      <div class="splide__progress__bar" />
    </div>

    <SplideTrack>
      <SplideSlide>...</SplideSlide>
    </SplideTrack>
  </div>
</Splide>

Props

<Splide> accepts HTMLAttributes that will be assigned to a carousel root element, except for DOMAttributes. For instance, class and 'aria-label' are acceptable:

<Splide class="my-carousel" aria-label="My Favorite Images">
</Splide>

Additionally, it takes a few more props.

options

options: Options

Splide options as an object:

<Splide
  options={ {
    rewind: true,
    width : 800,
    gap   : '1rem',
  } }
>
</Splide>

tag

tag: 'div' | 'section' | 'header' | 'footer' | 'nav' = 'div'

Allows you to specify the tag name used for the root element. Although the default value is div for backward compatibility, 'section' is recommended.

If you are using header, footer, or nav, you have to provide the most appropriate landmark role together. Otherwise, your accessibility tree will be invalid.

<Splide tag="section"></Splide>

hasTrack

hasTrack: boolean = true

Determines whether to render a track or not.

Events

You can listen to all Splide events through the Splide component. The name of the callback function is generated by the original name with adding an "on" prefix, converting the format to the camelcase and removing colons. For example, "arrows:mounted" becomes "onArrowsMounted". The event list is available in this file.

<Splide onArrowsMounted={ ( splide, prev, next ) => { console.log( prev, next ) } }>

Note that the handler always takes the splide instance as the first argument, and original arguments after it.

Extensions

Using an extension requires some more code from the developer:

• Use SplideExtension instead of Splide
• define the script part as follows. Note that it contains part related to the extension. Modify it accordingly.

Typical code would be, here being the @splidejs/splide-extension-auto-scroll extension:

---
import "@splidejs/splide/css"
import { SplideExtension, SplideSlide } from 'astro-splide';
const options = {
  ...,   // regular options of splide
  autoScroll: {   // specific options of the used extension
    speed: 1,
  },
}
---
<SplideExtension options={options}>
  <SplideSlide>...</SplideSlide>
  <SplideSlide>...</SplideSlide>
  ...
</SplideExtension>

<script>
  import { initSplideExtension } from "astro-splide/js/splideExtensionUtils"
  import { AutoScroll } from '@splidejs/splide-extension-auto-scroll';  // update with your extension
  initSplideExtension({AutoScroll})  // update with your extension
</script>

Note that it is the user responsability to install the splide extension

Limitations: a single extension can be used in a rendered page

Example

Here is a small example:

---
import "@splidejs/splide/css"
import { Splide, SplideSlide } from 'astro-splide';
---
<Splide
  options={ {
    rewind: true,
    gap   : '1rem',
  } }
  aria-label="My Favorite Images"
>
  <SplideSlide>
    <img src="image1.jpg" alt="Image 1"/>
  </SplideSlide>
  <SplideSlide>
    <img src="image2.jpg" alt="Image 2"/>
  </SplideSlide>
  <SplideSlide>
    <img src="image3.jpg" alt="Image 3"/>
  </SplideSlide>
</Splide>

You can see working examples in this page. This points to the example source files

Support Splide

Please support the project if you like it!

• Github Star astro-splide
• GitHub Sponsors @splidejs/splide

License

Astro Splide and Splide are released under the MIT license. © 2024 Pascal Brand © 2021 Naotoshi Fujita