Auto-advance (WCAG 2.2.2) needs a visible control to stop it; that is why autoplay always draws the button. Prefer no autoplay for anything people must read in full.
Looping buttons
Turn on loop for a ring of slides, so the buttons wrap from the last slide back to the first.
Three stories
Three customer stories with loop on.
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
children: slides
app-carousel-slide: each child tag is one slide
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
autoplay: none or a number
autoplay omitted (default)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
autoplay="5000"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
loop: true or false
loop="false" (default)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
loop="true"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
perView: 1 to 3
per-view="1" (default)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view="2"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view="3"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
perViewMd: 1 to 4
per-view-md="1"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-md="2"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-md="3"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-md="4"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
perViewLg: 1 to 5
per-view-lg="1"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-lg="2"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-lg="3"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-lg="4"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
per-view-lg="5"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
arrows: true or false
arrows="true" (default)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
arrows="false"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
dots: true or false
dots="true" (default)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
dots="false"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
previousLabel: text
previous-label="Back" (accessible name, not drawn)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
nextLabel: text
next-label="Forward" (accessible name, not drawn)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
dotLabel: text
dot-label="Show slide" (accessible name, not drawn)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
pauseLabel: text
pause-label="Hold" (shown with autoplay)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
playLabel: text
play-label="Resume" (shown after Pause)
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
className: text
class="mb-3"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
style: object
style="opacity: 0.6"
“Compliance tracking is now faster and more reliable.”
Clasp
“Ordering is smooth and the solution just works.”
Parliament of India
“We see every dispatch the moment it leaves the depot.”
Northwind Traders
Guidance
What to do, and what to avoid.
Use it when
A handful of equal slides: testimonials, featured items.
Content that is fine to read a slide at a time.
Reach for something else when
Steps a person must complete in order. → AppWizard
A long list people scan and filter. → AppDataTable
Reference
Try every prop, read the full list, and check keyboard and screen reader behaviour.
13 props. The 5 most used come first.
Used on most screens 5 props
Prop
Type
Default
Description
labeldefault -
string
-
What the slides are ("Customer stories"): the carousel's accessible name.
autoplaydefault -
int
-
Milliseconds between automatic steps (5000 is typical). Omit for none.
loopdefault false
bool
false
The previous and next buttons wrap around at the ends.
per-viewdefault 1
int
1
Slides in view on a phone.
arrowsdefault true
bool
true
Show the previous and next buttons.
Less common 8 props
Prop
Type
Default
Description
per-view-mddefault -
int
-
Slides in view from the md breakpoint. Defaults to per-view.
per-view-lgdefault -
int
-
Slides in view from the lg breakpoint. Defaults to per-view-md.
dotsdefault true
bool
true
Show the page dots.
previous-labeldefault Previous slide
string
Previous slide
The previous button's name.
next-labeldefault Next slide
string
Next slide
The next button's name.
dot-labeldefault Go to slide
string
Go to slide
The words before the slide number in each dot's name.
pause-labeldefault Pause
string
Pause
The pause button's text and name while playing.
play-labeldefault Play
string
Play
The pause button's text and name while paused.
Screen reader
3 notes
The carousel is a named region with the role description carousel; the label names it.
Each slide is a group described as a slide; the slide row takes keyboard focus and moves with the arrow, Home and End keys; the previous and next buttons are named by previousLabel and nextLabel.
The pause button is named by pauseLabel while playing and by playLabel while paused; each page dot is named by dotLabel and its slide number.