advanced-usage: add iframe widget

Documents bluerobotics/cockpit#516 and bluerobotics/cockpit#523
ES-Alexander · Nov 24, 2023 · b384b6b · b384b6b
1 parent ee32e04
commit b384b6b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/advanced-usage/iframe-config.png b/advanced-usage/iframe-config.png
diff --git a/advanced-usage/iframe-widget.png b/advanced-usage/iframe-widget.png
diff --git a/advanced-usage/index.md b/advanced-usage/index.md
@@ -149,6 +149,15 @@ This is primarily useful for underwater vehicles.
 Configuration determines whether the exact depth value is shown, and the colour of the lines:
 {{ easy_image(src="depth-hud-config", width=500, center=true) }}
 
+##### IFrame
+
+The iframe widget provides an inline frame that can display another HTML page within the Cockpit interface.
+This is particularly useful for showing the interfaces and displays of BlueOS Extensions (e.g. for a sonar viewer):
+{{ easy_image(src="iframe-widget", width=400, center=true) }}
+
+Configuration determines the URL to fetch the page from, as well as the overall transparency of the iframe:
+{{ easy_image(src="iframe-config", width=400, center=true) }}
+
 ##### Image Viewer
 
 The image viewer widget shows an image that is accessible to the control station computer via its network.