- Docs
- Components
- Interface
- Data & Media
- Story Player
Tap-through stories with segmented progress and soft transitions
| Name | Type | Default | Description |
|---|---|---|---|
slides | { src, type?, title?, subtitle?, duration?, alt? }[] | four architecture photos | The stories in order. Videos (mp4, webm, mov) play muted and set their own length. |
author | string | "Studio Ostra" | Name in the header. |
avatar | string | initials | Small round image beside the name. Without one, the author's initials show. |
meta | string | "2h" | Small text after the name, like when it was posted. |
duration | number | 5000 | Milliseconds each photo stays on screen. A slide's own duration wins. |
autoplay | boolean | true | Moves through the stories on its own while in view. |
loop | boolean | true | Starts again from the first story after the last. |
transition | "blur" | "slide" | "cube" | "blur" | How one story gives way to the next: a soft blur, a sideways slide or a turning cube. |
kenBurns | boolean | true | Photos drift and zoom slowly while they are shown. |
width | number | 340 | Largest width in pixels. Narrower spaces shrink it. |
aspect | number | 9 / 16 | Width to height ratio of the story. |
radius | number | 24 | Corner radius. |
frame | "none" | "inset" | "none" | Inset sets the story inside a tinted frame with concentric corners. |
intro | boolean | true | The story rises in and the progress bars draw across the first time it scrolls into view. |
theme | "auto" | "light" | "dark" | "auto" | Auto matches the frame to the background behind it. |
accentColor | string | "#FFFFFF" | Colour of the filled progress bars. |
surfaceColor | string | from theme | Colour of the inset frame. |
onChange | (index: number) => void | — | Called when a new story shows. |
onEnd | () => void | — | Called after the last story. |
ref | { next, prev, goTo, play, pause } | — | Moves through the stories from your own code. |
className | string | — | Classes for the root element. |
style | CSSProperties | — | Inline styles for the root element. |
slides{ src, type?, title?, subtitle?, duration?, alt? }[]The stories in order. Videos (mp4, webm, mov) play muted and set their own length.
four architecture photosauthorstringName in the header.
"Studio Ostra"avatarstringSmall round image beside the name. Without one, the author's initials show.
initialsmetastringSmall text after the name, like when it was posted.
"2h"durationnumberMilliseconds each photo stays on screen. A slide's own duration wins.
5000autoplaybooleanMoves through the stories on its own while in view.
trueloopbooleanStarts again from the first story after the last.
truetransition"blur" | "slide" | "cube"How one story gives way to the next: a soft blur, a sideways slide or a turning cube.
"blur"kenBurnsbooleanPhotos drift and zoom slowly while they are shown.
truewidthnumberLargest width in pixels. Narrower spaces shrink it.
340aspectnumberWidth to height ratio of the story.
9 / 16radiusnumberCorner radius.
24frame"none" | "inset"Inset sets the story inside a tinted frame with concentric corners.
"none"introbooleanThe story rises in and the progress bars draw across the first time it scrolls into view.
truetheme"auto" | "light" | "dark"Auto matches the frame to the background behind it.
"auto"accentColorstringColour of the filled progress bars.
"#FFFFFF"surfaceColorstringColour of the inset frame.
from themeonChange(index: number) => voidCalled when a new story shows.
—onEnd() => voidCalled after the last story.
—ref{ next, prev, goTo, play, pause }Moves through the stories from your own code.
—classNamestringClasses for the root element.
—styleCSSPropertiesInline styles for the root element.
—