BetaPublic beta — Read the release notes
Documentation

Carousel

Horizontal slide-based content viewer.

Package
@solidiom/carousel
Version
0.0.1-next.0
Status
stable

Preview

This preview uses documentation-only styling. Ship with one of the included recipe outputs (CSS, Tailwind, or UnoCSS) for production styles.

Horizontal slide-based content viewer.

Usage

Compose Root, Viewport, Slide, PrevButton, NextButton.

import * as Carousel from "@solidiom/carousel"

;<Carousel.Root>Carousel content</Carousel.Root>

Installation

Install the package with pnpm add @solidiom/carousel. The package requires compatible solid-js and @solidjs/web peer dependencies.

Parts

Carousel exposes 5 parts:

  • Rootdata-part="root".
  • Viewportdata-part="viewport".
  • Slidedata-part="slide".
  • PrevButtondata-part="prevbutton".
  • NextButtondata-part="nextbutton".

Styling

Carousel carries data-scope="carousel" and data-part attributes on each part for CSS/recipe targeting. State attributes like data-state, data-disabled, and data-highlighted are exposed where applicable.

Keyboard & behavior

This primitive has no keyboard interaction. It renders content that does not independently receive focus or respond to key events.

Composition

Carousel is designed to compose with other primitives. Its parts can be combined with Field, Button, or other primitives as needed.

SSR and hydration

Carousel renders as semantic HTML during server rendering. Interactive behavior (keyboard handlers, state management) activates on hydration without layout shift.