Merge pull request #13 from qazsato/bind_deviceorientationabsolute

bind deviceorientationabsolute
qazsato · Dec 4, 2024 · a94a076 · a94a076
2 parents 411ac39 + 9b32275
commit a94a076
Show file tree

Hide file tree

Showing 15 changed files with 212 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ A **heading-up** compass for MapLibre GL JS 🧭
 ## About
 
 **maplibre-gl-compass** is a plugin for MapLibre GL JS.  
-This plugin rotates the map based on the values from the [deviceorientation event](https://developer.mozilla.org/en-US/docs/Web/API/Window/deviceorientation_event).  
+This plugin rotates the map based on the values from the [Device orientation events](https://developer.mozilla.org/en-US/docs/Web/API/Device_orientation_events).  
 Therefore, it can only be used on devices equipped with an orientation sensor, such as mobile devices.
 
 Demo page is [here](https://qazsato.github.io/maplibre-gl-compass).
@@ -41,15 +41,15 @@ map.addControl(new CompassControl())
 import { Map } from 'maplibre-gl'
 import 'maplibre-gl/dist/maplibre-gl.css'
 import { CompassControl } from 'maplibre-gl-compass'
-import type { WebkitDeviceOrientationEvent } from 'maplibre-gl-compass'
+import type { CompassEvent } from 'maplibre-gl-compass'
 import 'maplibre-gl-compass/style.css'
 
 const map = new Map({/* YOUR_MAP_OPTION */})
 
 const compass = new CompassControl({
   debug: true,    // Show debug view. Default is false.
-  timeout: 10000, // The maximum time to wait for a DeviceOrientationEvent. Default is 3000 [ms].
   visible: true,  // Show compass button. Default is true.
+  timeout: 10000, // The maximum time to wait for a DeviceOrientationEvent. Default is 3000 [ms].
 })
 
 compass.on('turnon', () => {
@@ -63,7 +63,7 @@ compass.on('turnoff', () => {
   map.setBearing(0)
 })
 
-compass.on('deviceorientation', (event: WebkitDeviceOrientationEvent) => {
+compass.on('compass', (event: CompassEvent) => {
   // Your custom logic is here!
 })
 
@@ -75,16 +75,22 @@ map.addControl(compass)
 | name    | default | description                                                |
 | ------- | ------- | ---------------------------------------------------------- |
 | debug   | false   | Show debug view.                                           |
-| timeout | 3000    | The maximum time[ms] to wait for a DeviceOrientationEvent. |
 | visible | true    | Show compass button.                                       |
+| timeout | 3000    | The maximum time[ms] to wait for a DeviceOrientationEvent. |
 
 ## Events
 
-| name              | description                                                                                                                                                                                                          |
-| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| turnon            | Triggered when the compass is turned on.                                                                                                                                                                             |
-| turnoff           | Triggered when the compass is turned off.                                                                                                                                                                            |
-| deviceorientation | Triggered when the device orientation changes. For more details on event properties, refer to [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/deviceorientation_event#event_properties). |
+| name    | description                                                                                                                                                                                                                                                 |
+| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| turnon  | Fired when the compass is turned on.                                                                                                                                                                                                                        |
+| turnoff | Fired when the compass is turned off.                                                                                                                                                                                                                       |
+| error   | Fired when the compass cannot be accessed due to permission denied or a timeout.                                                                                                                                                                            |
+| compass | Fired when the device orientation changes. <br> A `heading` number represents the difference between the motion of the device around the z axis of the world system and the direction of the north, expressed in degrees with values ranging from 0 to 360. |
+
+## Reference
+
+- https://developer.apple.com/documentation/webkitjs/deviceorientationevent
+- https://developer.mozilla.org/en-US/docs/Web/API/Window/deviceorientationabsolute_event
 
 ## License
 

diff --git a/docs/index-BkH9e1jg.css b/docs/index-BkH9e1jg.css
diff --git a/docs/index-CarpIPlA.js → docs/index-C-v9-Spc.js b/docs/index-CarpIPlA.js → docs/index-C-v9-Spc.js
diff --git a/docs/index-oS4W3OgK.css b/docs/index-oS4W3OgK.css
diff --git a/docs/index.html b/docs/index.html
@@ -5,10 +5,18 @@
     <link rel="icon" type="image/svg+xml" href="/maplibre-gl-compass/compass.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>maplibre-gl-compass</title>
-    <script type="module" crossorigin src="/maplibre-gl-compass/index-CarpIPlA.js"></script>
-    <link rel="stylesheet" crossorigin href="/maplibre-gl-compass/index-oS4W3OgK.css">
+    <script type="module" crossorigin src="/maplibre-gl-compass/index-C-v9-Spc.js"></script>
+    <link rel="stylesheet" crossorigin href="/maplibre-gl-compass/index-BkH9e1jg.css">
   </head>
   <body>
-    <div id="app"></div>
+    <div id="app">
+      <header>
+        <h1>maplibre-gl-compass</h1>
+        <div>
+          <a href="https://github.com/qazsato/maplibre-gl-compass" class="github-corner" aria-label="View source on GitHub"><svg width="60" height="60" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"/><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"/><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"/></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
+        </div>
+      </header>
+      <div id="map"></div>
+    </div>
   </body>
 </html>
diff --git a/index.html b/index.html
@@ -7,7 +7,15 @@
     <title>maplibre-gl-compass</title>
   </head>
   <body>
-    <div id="app"></div>
+    <div id="app">
+      <header>
+        <h1>maplibre-gl-compass</h1>
+        <div>
+          <a href="https://github.com/qazsato/maplibre-gl-compass" class="github-corner" aria-label="View source on GitHub"><svg width="60" height="60" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"/><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"/><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"/></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
+        </div>
+      </header>
+      <div id="map"></div>
+    </div>
     <script type="module" src="/src/main.ts"></script>
   </body>
 </html>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maplibre-gl-compass",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A heading-up compass for MapLibre GL JS",
   "type": "module",
   "files": [

diff --git a/src/components/DebugView.css b/src/components/DebugView.css
@@ -6,4 +6,10 @@
   background-color: #fff;
   border-radius: 4px;
   box-shadow: 0 0 0 2px rgba(0,0,0,.1);
+
+  li {
+    overflow: hidden;
+    white-space: nowrap;
+    text-overflow: ellipsis;
+  }
 }
diff --git a/src/components/DebugView.ts b/src/components/DebugView.ts
@@ -1,3 +1,4 @@
+import { WebkitDeviceOrientationEvent } from '../maplibre-gl-compass'
 import './DebugView.css'
 
 export class DebugView {
@@ -8,16 +9,26 @@ export class DebugView {
     this.element.classList.add('maplibregl-ctrl')
     this.element.innerHTML = `
     <ul class="maplibregl-ctrl-compass-heading-debug">
+      <li><b>event</b>: <span class="event-name"></span></li>
       <li><b>heading</b>: <span class="heading"></span></li>
+      <li><b>alpha</b>: <span class="alpha"></span></li>
+      <li><b>beta</b>: <span class="beta"></span></li>
+      <li><b>gamma</b>: <span class="gamma"></span></li>
     </ul>
     `
     parent.appendChild(this.element)
   }
 
-  update(heading: string) {
+  update(heading?: number, event?: WebkitDeviceOrientationEvent) {
+    const eventName = this.element.querySelector('.event-name')
     const headingSpan = this.element.querySelector('.heading')
-    if (headingSpan) {
-      headingSpan.textContent = heading
-    }
+    const alphaSpan = this.element.querySelector('.alpha')
+    const betaSpan = this.element.querySelector('.beta')
+    const gammaSpan = this.element.querySelector('.gamma')
+    if (eventName) eventName.textContent = event?.type || ''
+    if (headingSpan) headingSpan.textContent = `${heading || ''}`
+    if (alphaSpan) alphaSpan.textContent = `${event?.alpha || ''}`
+    if (betaSpan) betaSpan.textContent = `${event?.beta || ''}`
+    if (gammaSpan) gammaSpan.textContent = `${event?.gamma || ''}`
   }
 }
diff --git a/src/main.ts b/src/main.ts
@@ -10,7 +10,7 @@ import { Protocol } from 'pmtiles'
 import { CompassControl } from './maplibre-gl-compass'
 
 const map = new Map({
-  container: 'app',
+  container: 'map',
   style:
     'https://api.protomaps.com/styles/v4/light/en.json?key=afde32549db516d8',
   center: [139.7538, 35.6674],
@@ -31,12 +31,11 @@ compass.on('turnoff', () => {
   map.setBearing(0)
 })
 
-map.addControl(compass, 'top-left')
-map.addControl(new NavigationControl({ showCompass: true }), 'top-right')
+map.addControl(new NavigationControl({ showCompass: false }))
 map.addControl(
   new GeolocateControl({
     positionOptions: { enableHighAccuracy: true },
     trackUserLocation: true,
   }),
-  'top-right',
 )
+map.addControl(compass)