@foxglove/extension 2.34.0 → 2.36.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/extension",
-  "version": "2.34.0",
+  "version": "2.36.0",
   "license": "MIT",
   "author": {
     "name": "Foxglove Technologies",

package/src/experimental.ts

@@ -34,6 +34,8 @@ export namespace Experimental {
     wasmUrl: string;
     /** The file extension that this data loader should be associated with. */
     supportedFileType: `.${string}`;
+    /** Whether the data loader supports being passed multiple files */
+    supportsMultiFile?: boolean;
   };
 
   /**
@@ -46,6 +48,30 @@ export namespace Experimental {
    */
   export type RegisterDataLoaderArgs = RegisterLocalFileDataLoaderArgs;
 
+  /**
+   * This type represents the arguments you pass to {@link ExtensionContext.registerPanel}.
+   *
+   * @category Custom panels
+   */
+  export type ExtensionPanelRegistration = {
+    /**
+     * Unique name of the panel within your extension
+     *
+     * NOTE: Panel names within your extension must be unique. The panel name identifies this panel
+     * within a layout. Changing the panel name will cause layouts using the old name unable to load
+     * your panel.
+     */
+    name: string;
+
+    /**
+     * This function is invoked when your panel is initialized
+     *
+     * @returns (optional) A function which will be called when the panel is removed or replaced.
+     * Perform any cleanup logic here to gracefully tear down your panel.
+     */
+    initPanel: (context: PanelExtensionContext) => void | (() => void);
+  };
+
   export interface ExtensionContext extends BaseExtensionContext {
     /**
      * Register a data loader to add support for additional file formats.
@@ -63,6 +89,16 @@ export namespace Experimental {
      * See: {@link PanelOverlayExtensionArgs}
      */
     registerPanelOverlay(args: PanelOverlayExtensionArgs): void;
+
+    /**
+     * `registerPanel` adds a new panel to the Foxglove interface. To register a panel you provide a
+     * `name` and an `initPanel` function.
+     *
+     * The `initPanel` function accepts a {@link PanelExtensionContext} argument, which contains
+     * properties and methods for accessing panel data and rendering UI updates. It also returns an
+     * optional cleanup function to run when the extension `panelElement` unmounts.
+     */
+    registerPanel(params: ExtensionPanelRegistration): void;
   }
 
   export interface ExtensionModule {
@@ -87,7 +123,7 @@ export namespace Experimental {
     /** Tooltip text to display when hovering over the button. */
     tooltip?: string;
     /** Function to call when the button is clicked. */
-    onClick?: (e: MouseEvent) => void;
+    onClick?: (event: MouseEvent) => void;
     /** Whether the button is disabled. */
     disabled?: boolean;
     /** Data test id to apply to the button, useful for testing. */