Embed the Rerun web viewer within your app.
This package is framework-agnostic. A React wrapper is available at https://www.npmjs.com/package/@rerun-io/web-viewer-react.
$ npm i @rerun-io/web-viewer
ℹ️ Note:
The package version is equal to the supported rerun SDK version.
This means that @rerun-io/web-viewer@0.10.0
can only connect to a data source (.rrd
file, websocket connection, etc.) that originates from a rerun SDK with version 0.10.0
!
The web viewer is an object which manages a canvas element:
import { WebViewer } from "@rerun-io/web-viewer";
const rrd = "…";
const parentElement = document.body;
const viewer = new WebViewer();
await viewer.start(rrd, parentElement);
// …
viewer.stop();
The rrd
in the snippet above should be a URL pointing to either:
- A hosted
.rrd
file, such as https://app.rerun.io/version/0.15.1/examples/dna.rrd - A WebSocket connection to the SDK opened via the
serve
API
If rrd
is not set, the viewer will display the same welcome screen as https://app.rerun.io.
For a full example, see https://github.com/rerun-io/web-viewer-example. You can open the example via CodeSandbox: https://codesandbox.io/s/github/rerun-io/web-viewer-example
ℹ️ Note: This package only targets recent versions of browsers. If your target browser does not support Wasm imports or top-level await, you may need to install additional plugins for your bundler.
$ npm run build