docstring

Signed-off-by: Chris Gervang <[email protected]>
visgl · Oct 25, 2024 · b9cef03 · b9cef03
1 parent 5a32240
commit b9cef03
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/modules/widgets/src/compass-widget.tsx b/modules/widgets/src/compass-widget.tsx
@@ -5,6 +5,9 @@ import {render} from 'preact';
 
 interface CompassWidgetProps {
   id?: string;
+  /**
+   * Widget positioning within the view. Default 'top-left'.
+   */
   placement?: WidgetPlacement;
   /**
    * View to attach to and interact with. Required when using multiple views.

diff --git a/modules/widgets/src/fullscreen-widget.tsx b/modules/widgets/src/fullscreen-widget.tsx
@@ -6,6 +6,9 @@ import {IconButton} from './components';
 
 interface FullscreenWidgetProps {
   id?: string;
+  /**
+   * Widget positioning within the view. Default 'top-left'.
+   */
   placement?: WidgetPlacement;
   /**
    * A [compatible DOM element](https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullScreen#Compatible_elements) which should be made full screen.