Skip to content

Commit 0377fdb

Browse files
committed
Docs for kiosk mode
1 parent d9f026d commit 0377fdb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

browsers/live-view.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,34 @@ To access the live view, visit the `browser_live_view_url` provided when you cre
1515
The `browser_live_view_url` supports additional query parameters to customize the live view:
1616
- `readOnly` (bool): when set to `true`, the view will be non-interactive.
1717

18+
## Kiosk mode
19+
20+
You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`. Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs.
21+
22+
<CodeGroup>
23+
24+
```typescript Typescript/Javascript
25+
const kernelBrowser = await kernel.browsers.create({
26+
viewport: {
27+
width: 1920,
28+
height: 1080
29+
},
30+
kiosk_mode: true
31+
});
32+
```
33+
34+
```python Python
35+
kernel_browser = client.browsers.create(
36+
viewport={
37+
"width": 1920,
38+
"height": 1080
39+
},
40+
kiosk_mode=True
41+
)
42+
```
43+
44+
</CodeGroup>
45+
1846
## Browser persistence
1947

2048
`browser_live_view_url` becomes invalid once the browser is [deleted](/browsers/termination) manually or via timeout.

0 commit comments

Comments
 (0)