Skip to content

Commit 791f205

Browse files
committed
add readme
1 parent 44f40f2 commit 791f205

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--[metadata]
2+
title = "Custom Viewer Callback"
3+
thumbnail = "https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/480w.png"
4+
thumbnail_dimensions = [480, 291]
5+
-->
6+
7+
Example showing how to control an app with the Rerun viewer, by extending the viewer UI.
8+
9+
The example builds on the [`extend_viewer_ui`](../extend_viewer_ui/) example, but is still rather basic.
10+
11+
## Architecture
12+
13+
```mermaid
14+
graph LR;
15+
App(App) --> Viewer(Viewer);
16+
Viewer(Viewer) --> App(App);
17+
```
18+
19+
<picture>
20+
<img src="https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/full.png" alt="Custom Viewer Callback example screenshot">
21+
<source media="(max-width: 480px)" srcset="https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/480w.png">
22+
<source media="(max-width: 768px)" srcset="https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/768w.png">
23+
<source media="(max-width: 1024px)" srcset="https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/1024w.png">
24+
<source media="(max-width: 1200px)" srcset="https://static.rerun.io/custom_callback/1434da408fd59ea1349169784b47d8ffc285022e/1200w.png">
25+
</picture>
26+
27+
[#2337](https://github.com/rerun-io/rerun/issues/2337): Note that in order to spawn a web viewer with these customizations applied,
28+
you have to build the web viewer of the version yourself.
29+
This is currently not supported outside of the Rerun repository.
30+
31+
## Testing it
32+
33+
First start the Rerun SDK app with `cargo run -p custom_callback --bin custom_callback_app`,
34+
and then start the extended viewer with `cargo run -p custom_callback --bin custom_callback_viewer`.

0 commit comments

Comments
 (0)