@rerun-io/web-viewer - npm Package Compare versions

Comparing version 0.17.0 to 0.18.0-rc.1

index.d.ts

@@ -5,11 +5,35 @@ export type Panel = "top" | "blueprint" | "selection" | "time";
 export interface WebViewerOptions {
+    /** Url to the example manifest. Unused if `hide_welcome_screen` is set to `true`. */
     manifest_url?: string;
+    /** The render backend used by the viewer. Either "webgl" or "webgpu". Prefers "webgpu". */
     render_backend?: Backend;
+    /** If set to `true`, hides the welcome screen, which contains our examples. Defaults to `false`. */
     hide_welcome_screen?: boolean;
+    /**
+     * Allow the viewer to handle fullscreen mode.
+     * This option sets canvas style so is not recommended if you are doing anything custom,
+     * or are embedding the viewer in an iframe.
+     *
+     * Defaults to `false`.
+     */
     allow_fullscreen?: boolean;
+    /**
+     * Enable the history feature of the viewer.
+     *
+     * This is only relevant when `hide_welcome_screen` is `false`,
+     * as it's currently only used to allow going between the welcome screen and examples.
+     *
+     * Defaults to `false`.
+     */
     enable_history?: boolean;
+    /** The CSS width of the canvas. */
     width?: string;
+    /** The CSS height of the canvas. */
     height?: string;
 }
-/** @private */
+/**
+ * The public interface is @see {WebViewerOptions}
+ *
+ * @private
+ */
 export interface AppOptions extends WebViewerOptions {
@@ -16,0 +40,0 @@ url?: string;

index.ts

@@ -50,10 +50,38 @@ import type { WebHandle, wasm_bindgen } from "./re_viewer";
 
+// NOTE: When changing these options, consider how it affects the `web-viewer-react` package:
+//       - Should this option be exposed?
+//       - Should changing this option result in the viewer being restarted?
 export interface WebViewerOptions {
+  /** Url to the example manifest. Unused if `hide_welcome_screen` is set to `true`. */
   manifest_url?: string;
+
+  /** The render backend used by the viewer. Either "webgl" or "webgpu". Prefers "webgpu". */
   render_backend?: Backend;
+
+  /** If set to `true`, hides the welcome screen, which contains our examples. Defaults to `false`. */
   hide_welcome_screen?: boolean;
+
+  /**
+   * Allow the viewer to handle fullscreen mode.
+   * This option sets canvas style so is not recommended if you are doing anything custom,
+   * or are embedding the viewer in an iframe.
+   *
+   * Defaults to `false`.
+   */
   allow_fullscreen?: boolean;
+
+  /**
+   * Enable the history feature of the viewer.
+   *
+   * This is only relevant when `hide_welcome_screen` is `false`,
+   * as it's currently only used to allow going between the welcome screen and examples.
+   *
+   * Defaults to `false`.
+   */
   enable_history?: boolean;
 
+  /** The CSS width of the canvas. */
   width?: string;
+
+  /** The CSS height of the canvas. */
   height?: string;
@@ -65,3 +93,7 @@ }
 
-/** @private */
+/**
+ * The public interface is @see {WebViewerOptions}
+ *
+ * @private
+ */
 export interface AppOptions extends WebViewerOptions {
@@ -68,0 +100,0 @@ url?: string;

package.json

 {
   "name": "@rerun-io/web-viewer",
-  "version": "0.17.0",
+  "version": "0.18.0-rc.1",
   "description": "Embed the Rerun web viewer in your app",
@@ -5,0 +5,0 @@ "licenses": [

re_viewer_bg.wasm.d.ts

@@ -48,18 +48,19 @@ /* tslint:disable */
 export const __wbindgen_export_3: WebAssembly.Table;
+export function wasm_bindgen__convert__closures__invoke0_mut__he7101bdda3d8ddc1(a: number, b: number): void;
 export function __wbindgen_add_to_stack_pointer(a: number): number;
-export function closure157_externref_shim(a: number, b: number, c: number, d: number): void;
+export function closure810_externref_shim(a: number, b: number, c: number, d: number): void;
 export function __externref_table_dealloc(a: number): void;
-export function wasm_bindgen__convert__closures__invoke0_mut__h71277427381bcdff(a: number, b: number): void;
+export function wasm_bindgen__convert__closures__invoke0_mut__hca3fde335c0a19d0(a: number, b: number, c: number): void;
+export function closure4218_externref_shim(a: number, b: number, c: number): void;
+export function wasm_bindgen__convert__closures__invoke0_mut__h7c3623b7e8a02546(a: number, b: number): void;
 export function _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h481a4c2bb2473fc6(a: number, b: number): void;
-export function closure5313_externref_shim(a: number, b: number, c: number): void;
-export function wasm_bindgen__convert__closures__invoke0_mut__h0a7a075e54c6df92(a: number, b: number, c: number): void;
-export function closure8038_externref_shim(a: number, b: number, c: number): void;
-export function closure11634_externref_shim(a: number, b: number, c: number): void;
-export function closure14103_externref_shim(a: number, b: number, c: number): void;
-export function closure14828_externref_shim(a: number, b: number, c: number): void;
-export function closure14841_externref_shim(a: number, b: number, c: number): void;
+export function closure7522_externref_shim(a: number, b: number, c: number): void;
+export function closure10118_externref_shim(a: number, b: number, c: number): void;
+export function closure12878_externref_shim(a: number, b: number, c: number): void;
+export function closure13014_externref_shim(a: number, b: number, c: number): void;
+export function closure13027_externref_shim(a: number, b: number, c: number): void;
 export function __wbindgen_free(a: number, b: number, c: number): void;
 export function __wbindgen_exn_store(a: number): void;
 export function __externref_table_alloc(): number;
-export function closure17225_externref_shim(a: number, b: number, c: number, d: number): void;
+export function closure15697_externref_shim(a: number, b: number, c: number, d: number): void;
 export function __wbindgen_start(): void;

re_viewer.d.ts

@@ -199,18 +199,19 @@
   readonly __wbindgen_export_3: WebAssembly.Table;
+  readonly wasm_bindgen__convert__closures__invoke0_mut__he7101bdda3d8ddc1: (a: number, b: number) => void;
   readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly closure157_externref_shim: (a: number, b: number, c: number, d: number) => void;
+  readonly closure810_externref_shim: (a: number, b: number, c: number, d: number) => void;
   readonly __externref_table_dealloc: (a: number) => void;
-  readonly wasm_bindgen__convert__closures__invoke0_mut__h71277427381bcdff: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke0_mut__hca3fde335c0a19d0: (a: number, b: number, c: number) => void;
+  readonly closure4218_externref_shim: (a: number, b: number, c: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke0_mut__h7c3623b7e8a02546: (a: number, b: number) => void;
   readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h481a4c2bb2473fc6: (a: number, b: number) => void;
-  readonly closure5313_externref_shim: (a: number, b: number, c: number) => void;
-  readonly wasm_bindgen__convert__closures__invoke0_mut__h0a7a075e54c6df92: (a: number, b: number, c: number) => void;
-  readonly closure8038_externref_shim: (a: number, b: number, c: number) => void;
-  readonly closure11634_externref_shim: (a: number, b: number, c: number) => void;
-  readonly closure14103_externref_shim: (a: number, b: number, c: number) => void;
-  readonly closure14828_externref_shim: (a: number, b: number, c: number) => void;
-  readonly closure14841_externref_shim: (a: number, b: number, c: number) => void;
+  readonly closure7522_externref_shim: (a: number, b: number, c: number) => void;
+  readonly closure10118_externref_shim: (a: number, b: number, c: number) => void;
+  readonly closure12878_externref_shim: (a: number, b: number, c: number) => void;
+  readonly closure13014_externref_shim: (a: number, b: number, c: number) => void;
+  readonly closure13027_externref_shim: (a: number, b: number, c: number) => void;
   readonly __wbindgen_free: (a: number, b: number, c: number) => void;
   readonly __wbindgen_exn_store: (a: number) => void;
   readonly __externref_table_alloc: () => number;
-  readonly closure17225_externref_shim: (a: number, b: number, c: number, d: number) => void;
+  readonly closure15697_externref_shim: (a: number, b: number, c: number, d: number) => void;
   readonly __wbindgen_start: () => void;
@@ -217,0 +218,0 @@ }

README.md

@@ -44,3 +44,3 @@ # Rerun web viewer
 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.17.0/examples/dna.rrd>
+- A hosted `.rrd` file, such as <https://app.rerun.io/version/0.18.0-rc.1/examples/dna.rrd>
 - A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API
@@ -47,0 +47,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

5035

increased by1.21%

Worsened metrics

Total package byte prevSize

23445606

decreased by-3.01%

No dependency changes