When to use it. A horizontally paged container that reveals one panel at a time. Each panel is a group (its own label, grid, and nested children), so a carousel is a "set of groups" you swipe between. The active page index is the control value, so it syncs and fires actions, and a jump of several pages riffles through the intermediate ones.
Type
carousel
Also titled
Carousel
Default size
3 rows × 2 columns
Symbol
rectangle.stack
Docs
Docs complete
Search for it as
swipe
slider
slideshow
gallery
pager
pages
Rendered by the app
Fields
7 fields you can set on a carousel control. Every control also takes the shared fields (id, position, span, sync, action).
Fields
Field
Type
Default
What it does
StylecarouselMode
choiceone of 3
paged
How the pages are laid out as you swipe
Switches between one full page at a time, a tilted row of neighbors, or a stack of cards.
pageddefaultone full-width page at a time that snaps into place
coverflowthe active page centered with smaller tilted neighbors at the sides
deckpages stacked like cards; the front card swipes away to show the next
Indicatorindicator
choiceone of 3
dots
The little marks that show which page you are on
Draws a row of dots or bars below the pages with the current one in the accent color, or hides it.
dotsdefaulta row of small round dots
barsa row of short flat bars
noneno page marks shown
autoAdvanceautoAdvance
number0–60step 1
0
Turns the pages by itself on a timer
Moves to the next page every this many seconds (0 to 60); 0 keeps it manual.
Looploop
on / off
false(off)
Lets the pages go round in a circle
On, swiping past the last page returns to the first and the reverse; off, the ends resist with a rubber-band.
panelspanels
object
—
The pages themselves
Supplies the list of pages; each group definition becomes one swipeable page holding its own controls.
containerAnimationcontainerAnimation
object
—
How the pages animate when switching
Tunes the page transition: motion profile, duration, bounce and the side or stack shape in coverflow and deck.
defaultValuedefaultValue
numberstep 1
0
Which page shows first
Opens on this page number when the layout appears, counting from 0 for the first page.
Theme fields
Restyle one control by setting these in its theme object; a layout's theme sets them for every control.
Theme fields
Field
Type
Default
What it does
surfacePrimarytheme.surfacePrimary
color
#FFFFFF0F
The fill behind each page
Colors the card behind every page; a low-opacity white gives a faint glass tint.
accentColortheme.accentColor
color
#667eea
The color of the current page mark
Colors the dot or bar for the page you are on in the indicator.
cornerRadiustheme.cornerRadius
number0–30 ptstep 1
12
How round the page corners are
Rounds each page card's corners by this many points (0 square to 30 very round).
Frosted glasstheme.blurEnabled
on / off
true(on)
How thick the page outline is
Sets the outline width around each page card in points (0 hides it, 5 is heavy).
Card spacingtheme.cardPadding
number0–32 ptstep 1
12
The softer color of supporting writing
Colors the secondary text inside the pages, such as captions and hints.
Emits and receives
What this control sends when you use it, and what it can show or follow when data arrives.
Emits
Emits
Sends
When
Type
What it sends
When you swipe to another pagevalue
change
number
the position of the page you landed on, counting from 0
Example: 1
Receives
Receives
Takes
From
Type
What it does
valuefollow
hub, mqtt, http, store, default
number
the position of the page to show, counting from 0
the carousel pages to it with animation, riffling through any pages in between
Example: 1
Examples
5 examples, each one a control you can paste into a layout.
Every hinted field here (Style, Indicator, Loop) changes something on screen; panels and containerAnimation are edited in the layout structure and the animation tab rather than by a single control.
Try it on your phone
carterkit serves a small hub on your computer and pushes one example to CAR-TER on your iPhone or iPad. Pair once with the code it prints.
Install the Python kit.
pipinstallcarterkit
Show “Paged (the default) with a starting page” on your phone.
One full-width panel at a time, with a spring snap and rubber-band at the ends (unless
loop).
coverflow
The active panel is centered; neighbors are scaled down, pushed to the sides, rotated in 3D,
and faded. Tune with containerAnimation.sideScale, sideRotation, sideSpacing,
sideOpacity.
deck
Panels stack in front of/behind each other with depth; the front card swipes away to reveal
the next. Tune with containerAnimation.deckVisibleCount, deckScaleStep, deckOffsetStep,
deckRotation.
Animation Customization
All motion lives in the optional containerAnimation object:
Field
Type
Default
Description
profile
string
bouncy
snappy/smooth/bouncy/gentle/instant
duration
number
—
Override transition seconds
bounce
number
—
Spring bounce 0–1
multiStep
bool
true
Riffle through pages on a multi-page jump
stepInterval
number
0.12
Seconds per intermediate step
sideScale
number
0.82
(coverflow) neighbor scale
sideRotation
number
45
(coverflow) neighbor 3D rotation°
sideSpacing
number
0.55
(coverflow) neighbor offset, fraction of width
sideOpacity
number
0.6
(coverflow) neighbor opacity
deckVisibleCount
number
3
(deck) visible stacked cards
deckScaleStep
number
0.06
(deck) scale reduction per layer
deckOffsetStep
number
14
(deck) point offset per layer
deckRotation
number
0
(deck) fan rotation° per layer
Theming
Panels render as glass cards from the active theme (surfacePrimary,
cornerRadius, borderColor, cardPadding). The active indicator uses accentColor. Set
hideBackground on a panel for a transparent page, or per-child theme overrides inside a
panel.