Carousel

A slide carousel with previous/next controls and arrow-key navigation.

Installation

Shadwire follows shadcn/ui's open code model: the component's source is copied into your application and becomes yours. Install it with the CLI:

shadwire add carousel --yes

The carousel registry item installs these files:

app/components/ui_component.rb
app/components/ui/carousel_component.rb
app/components/ui/carousel/content_component.rb
app/components/ui/carousel/item_component.rb
app/components/ui/carousel/previous_component.rb
app/components/ui/carousel/next_component.rb
app/helpers/ui/carousel_helper.rb
app/javascript/controllers/ui_carousel_controller.js
vendor/shadwire/shadwire.css

This component uses Stimulus, so the application needs importmap-rails and stimulus-rails with automatic controller loading.

Haven't installed the CLI yet? gem install shadwire, then shadwire init.

Usage

<%= ui_carousel do %>
  <%= ui_carousel_content do %>
    <%= ui_carousel_item { "Slide 1" } %>
    <%= ui_carousel_item { "Slide 2" } %>
  <% end %>
  <%= ui_carousel_previous %>
  <%= ui_carousel_next %>
<% end %>

Examples

Default

Five numbered slides with controls.

<%= ui_carousel(class: "mx-12 w-full max-w-xs") do %>
  <%= ui_carousel_content do %>
    <% (1..5).each do |n| %>
      <%= ui_carousel_item(class: "p-1") do %>
        <div class="flex aspect-square items-center justify-center rounded-md border bg-card text-4xl font-semibold"><%= n %></div>
      <% end %>
    <% end %>
  <% end %>

<%= ui_carousel(class: "mx-12 w-full max-w-xs") do %>
  <%= ui_carousel_content do %>
    <% (1..5).each do |n| %>
      <%= ui_carousel_item(class: "p-1") do %>
        <div class="flex aspect-square items-center justify-center rounded-md border bg-card text-4xl font-semibold"><%= n %></div>
      <% end %>
    <% end %>
  <% end %>
  <%= ui_carousel_previous %>
  <%= ui_carousel_next %>
<% end %>

API reference

Every part accepts class / class_name and **attrs.

Component	Argument	Default	Description
`Carousel`	`orientation`	`:horizontal`	`:horizontal` or `:vertical`; give `ui_carousel_content` the same value.
`Carousel::Content`	`orientation`	`:horizontal`	The carousel's `orientation:`, repeated.