- Docs
- Components
- Interface
- Product Mockups
- Browser Window
A browser window that navigates through your pages and screenshots
| Name | Type | Default | Description |
|---|---|---|---|
pages | BrowserPage[] | three studio pages | The pages to show. Each page is { url, title?, src?, alt?, content? }. src is a screenshot or image, content renders your own markup instead. title labels the tab in the tabs chrome. |
children | ReactNode | — | Shows a single page with your own content instead of pages. Pair it with url. |
url | string | "localhost:3000" | Address shown when you pass children. |
chrome | "compact" | "tabs" | "compact" | Compact is one toolbar with a centred address bar. Tabs adds a row of clickable page tabs above the toolbar. |
frame | "solid" | "inset" | "inset" | Solid draws one surface. Inset puts the toolbar on a tinted frame and sets the page in its own rounded panel, with corners concentric to the frame. |
dots | "mono" | "color" | "mono" | Window dots in quiet grey, or the classic red, yellow and green. |
theme | "auto" | "light" | "dark" | "auto" | Auto picks a light or dark window from the colour behind it, so it follows your site theme. |
accentColor | string | theme violet | Colour of the loading bar, the typing caret and the active tab icon. |
windowColor | string | from theme | Background of the window chrome. |
textColor | string | from theme | Colour of the address and tab labels. |
radius | number | 16 | Corner radius of the window in pixels. |
aspect | number | 1.6 | Width to height ratio of the page area. |
height | number | — | Fixed height of the page area in pixels. Overrides aspect. |
fit | "cover" | "contain" | "cover" | How screenshots fill the page area. Cover aligns them to the top. |
transition | "blur" | "slide" | "fade" | "blur" | How a new page appears. |
interval | number | 4600 | Milliseconds each page stays on screen while autoplaying. |
autoplay | boolean | true | Moves through the pages on its own while the window is in view. |
loop | boolean | true | Returns to the first page after the last. |
pauseOnHover | boolean | true | Holds the current page while the pointer is over the window. |
typing | boolean | true | Types the new address into the address bar on each navigation. |
loader | boolean | true | Runs a thin loading bar under the toolbar on each navigation. |
scroll | boolean | true | Slowly scrolls screenshots that are taller than the page area. |
controls | boolean | true | Shows working back, forward and reload buttons. |
defaultPage | number | 0 | Page shown first. |
onPageChange | (index: number) => void | — | Called whenever the window shows another page. |
ref | { next, prev, goTo, reload, play, pause } | — | Controls navigation, for example to sync the window with your own feature list. |
className | string | — | Classes for the window. |
style | CSSProperties | — | Inline styles for the window. |
pagesBrowserPage[]The pages to show. Each page is { url, title?, src?, alt?, content? }. src is a screenshot or image, content renders your own markup instead. title labels the tab in the tabs chrome.
three studio pageschildrenReactNodeShows a single page with your own content instead of pages. Pair it with url.
—urlstringAddress shown when you pass children.
"localhost:3000"chrome"compact" | "tabs"Compact is one toolbar with a centred address bar. Tabs adds a row of clickable page tabs above the toolbar.
"compact"frame"solid" | "inset"Solid draws one surface. Inset puts the toolbar on a tinted frame and sets the page in its own rounded panel, with corners concentric to the frame.
"inset"dots"mono" | "color"Window dots in quiet grey, or the classic red, yellow and green.
"mono"theme"auto" | "light" | "dark"Auto picks a light or dark window from the colour behind it, so it follows your site theme.
"auto"accentColorstringColour of the loading bar, the typing caret and the active tab icon.
theme violetwindowColorstringBackground of the window chrome.
from themetextColorstringColour of the address and tab labels.
from themeradiusnumberCorner radius of the window in pixels.
16aspectnumberWidth to height ratio of the page area.
1.6heightnumberFixed height of the page area in pixels. Overrides aspect.
—fit"cover" | "contain"How screenshots fill the page area. Cover aligns them to the top.
"cover"transition"blur" | "slide" | "fade"How a new page appears.
"blur"intervalnumberMilliseconds each page stays on screen while autoplaying.
4600autoplaybooleanMoves through the pages on its own while the window is in view.
trueloopbooleanReturns to the first page after the last.
truepauseOnHoverbooleanHolds the current page while the pointer is over the window.
truetypingbooleanTypes the new address into the address bar on each navigation.
trueloaderbooleanRuns a thin loading bar under the toolbar on each navigation.
truescrollbooleanSlowly scrolls screenshots that are taller than the page area.
truecontrolsbooleanShows working back, forward and reload buttons.
truedefaultPagenumberPage shown first.
0onPageChange(index: number) => voidCalled whenever the window shows another page.
—ref{ next, prev, goTo, reload, play, pause }Controls navigation, for example to sync the window with your own feature list.
—classNamestringClasses for the window.
—styleCSSPropertiesInline styles for the window.
—