Add rotation and contextMenu UI control options

.changeset/quick-donkeys-rotate.md

@@ -0,0 +1,5 @@
+---
+"@feltmaps/js-sdk": minor
+---
+
+Add `rotation` and `contextMenu` UI control options, for disabling map rotation and the right-click menu via `Felt.embed` and `updateUiControls`

docs/UI/UiControlsOptions.md

@@ -109,3 +109,43 @@ Whether or not the scale bar is shown in an embedded map.
 ```ts
 true
 ```
+
+***
+
+## rotation?
+
+> `optional` **rotation**: `boolean`
+
+Whether or not the map can be rotated.
+
+### Remarks
+
+This affects all rotation interactions — dragging with the right mouse
+button or Ctrl held, two-finger touch rotation, and keyboard shortcuts —
+as well as the compass control, which is hidden when rotation is
+disabled.
+
+### Default Value
+
+```ts
+true
+```
+
+***
+
+## contextMenu?
+
+> `optional` **contextMenu**: `boolean`
+
+Whether or not the right-click context menu is available on the map.
+
+### Remarks
+
+When disabled, right-clicking the map opens neither Felt's context menu
+nor the browser's own.
+
+### Default Value
+
+```ts
+true
+```

src/modules/main/index.ts

@@ -57,6 +57,8 @@ export const Felt = {
         geolocation: false,
         zoomControls: true,
         scaleBar: true,
+        rotation: true,
+        contextMenu: true,
       },
       initialViewport: undefined,
       origin: "https://felt.com",
@@ -76,6 +78,8 @@ export const Felt = {
       geolocation: "geolocation",
       zoomControls: "zoomControls",
       scaleBar: "scaleBar",
+      rotation: "rotation",
+      contextMenu: "contextMenu",
     };
 
     const uiControlsOptions = {

src/modules/ui/types.ts

@@ -293,6 +293,30 @@ export const UiControlsOptionsSchema = z.object({
    * @defaultValue true
    */
   scaleBar: z.boolean().optional(),
+
+  /**
+   * Whether or not the map can be rotated.
+   *
+   * @remarks
+   * This affects all rotation interactions — dragging with the right mouse
+   * button or Ctrl held, two-finger touch rotation, and keyboard shortcuts —
+   * as well as the compass control, which is hidden when rotation is
+   * disabled.
+   *
+   * @defaultValue true
+   */
+  rotation: z.boolean().optional(),
+
+  /**
+   * Whether or not the right-click context menu is available on the map.
+   *
+   * @remarks
+   * When disabled, right-clicking the map opens neither Felt's context menu
+   * nor the browser's own.
+   *
+   * @defaultValue true
+   */
+  contextMenu: z.boolean().optional(),
 });
 
 /**

tests/client.test.ts

@@ -86,6 +86,8 @@ describe("Embedding an iframe with theFelt SDK", () => {
         uiControls: {
           showLegend: false,
           zoomControls: false,
+          rotation: false,
+          contextMenu: false,
         },
         initialViewport: {
           center: { latitude: 40, longitude: -74 },
@@ -103,6 +105,8 @@ describe("Embedding an iframe with theFelt SDK", () => {
       expect(url.origin).toBe("https://example.com");
       expect(url.searchParams.get("legend")).toBe("0");
       expect(url.searchParams.get("zoomControls")).toBe("0");
+      expect(url.searchParams.get("rotation")).toBe("0");
+      expect(url.searchParams.get("contextMenu")).toBe("0");
       expect(url.searchParams.get("loc")).toBe("40,-74,10z");
       expect(url.searchParams.get("token")).toBe("test-token");
     });