@rerun-io/web-viewer-react 0.11.0-rc.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -12,6 +12,8 @@ Embed the Rerun web viewer within your React app.
|
|
|
12
12
|
</picture>
|
|
13
13
|
</p>
|
|
14
14
|
|
|
15
|
+
If you'd like to use a framework-agnostic package instead, see <https://www.npmjs.com/package/@rerun-io/web-viewer>.
|
|
16
|
+
|
|
15
17
|
## Install
|
|
16
18
|
|
|
17
19
|
```
|
|
@@ -28,17 +30,19 @@ This means that `@rerun-io/web-viewer-react@0.10.0` can only connect to a data s
|
|
|
28
30
|
import WebViewer from "@rerun-io/web-viewer-react";
|
|
29
31
|
|
|
30
32
|
export default function App() {
|
|
31
|
-
return
|
|
32
|
-
<div>
|
|
33
|
-
<WebViewer rrd="...">
|
|
34
|
-
</div>
|
|
35
|
-
)
|
|
33
|
+
return <WebViewer rrd="...">
|
|
36
34
|
}
|
|
37
35
|
```
|
|
38
36
|
|
|
37
|
+
The `rrd` in the snippet above should be a URL pointing to either:
|
|
38
|
+
- A hosted `.rrd` file, such as <https://demo.rerun.io/version/0.11.0/examples/dna/data.rrd>
|
|
39
|
+
- A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API
|
|
40
|
+
|
|
41
|
+
If `rrd` is not set, the viewer will display the same welcome screen as <https://app.rerun.io>.
|
|
42
|
+
|
|
39
43
|
ℹ️ Note:
|
|
40
44
|
This package only targets recent versions of browsers.
|
|
41
|
-
If your target browser does not support Wasm imports, you may need to install additional plugins for your bundler.
|
|
45
|
+
If your target browser does not support Wasm imports or top-level await, you may need to install additional plugins for your bundler.
|
|
42
46
|
|
|
43
47
|
## Development
|
|
44
48
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rerun-io/web-viewer-react",
|
|
3
|
-
"version": "0.11.0
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"description": "Embed the Rerun web viewer in your React app",
|
|
5
5
|
"private": false,
|
|
6
6
|
"scripts": {
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"tsconfig.json"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@rerun-io/web-viewer": "0.11.0
|
|
35
|
+
"@rerun-io/web-viewer": "0.11.0",
|
|
36
36
|
"@types/react": "^18.2.33",
|
|
37
37
|
"react": "^18.2.0"
|
|
38
38
|
},
|