-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implementation of HTMLMapmlViewerElement.matchMedia API,
depends on media-query-parser and media-query-solver.
Use multi-select values of contentPreference sent by mapml-extension
(relies on M.options.contentPreference being an array).
Update map-zoom handling to compare current map zoom against query
Add window.matchMedia query + event listener for color-scheme changes,
allows map to adapt without having to shake it.
Change the way prefers-lang selects the language (use navigator.language,
not navigator.languages, because other values aren't of use).
Make matchMedia(query).matches a boolean value
Added tests for map-zoom and prefers-color-scheme
Added tests for bounding box and map-projection
Added test for combined matchMedia API
Add matchMedia to web-map.js
Fix up some other stuff that had fallen through the cracks of keeping
mapml-viewer and web-map in sync
Create elementSupport/viewers/matchMedia.js, de-duplicates code
Import matchMedia from matchMedia.js into both mapml-viewer and web-map
Add MIT license for media-query-parser and -solver
Update version to 0.15.0
Added web-map test for combined-matchMedia
Add ${mapType} to title of each test so logs are explicit
Use map.getByTestId, on id generated to be unique within parent map- Loading branch information
1 parent
ddba5df
commit 3a006ea
Showing
20 changed files
with
1,039 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -184,3 +184,22 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2023 Tom Golden <[email protected]> | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and | ||
| associated documentation files (the "Software"), to deal in the Software without restriction, | ||
| including without limitation the rights to use, copy, modify, merge, publish, distribute, | ||
| sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial | ||
| portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT | ||
| NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES | ||
| OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,251 @@ | ||
| import { parseMediaQueryList } from 'media-query-parser'; | ||
| import { solveMediaQueryList } from 'media-query-solver'; | ||
|
|
||
| export const matchMedia = function (query) { | ||
| // useful features for maps: prefers-color-scheme, prefers-lang, projection, zoom, extent | ||
| const parsedQuery = parseMediaQueryList(query); | ||
|
|
||
| // less obviously useful: aspect-ratio, orientation, (device) resolution, overflow-block, overflow-inline | ||
|
|
||
| const map = this; | ||
| const features = { | ||
| 'prefers-lang': { | ||
| type: 'discrete', | ||
| get values() { | ||
| return [navigator.language.substring(0, 2)]; | ||
| } | ||
| }, | ||
| 'map-projection': { | ||
| type: 'discrete', | ||
| get values() { | ||
| return [map.projection.toLowerCase()]; | ||
| } | ||
| }, | ||
| 'map-zoom': { | ||
| type: 'range', | ||
| valueType: 'integer', | ||
| canBeNegative: false, | ||
| canBeZero: true, | ||
| get extraValues() { | ||
| return { | ||
| min: 0, | ||
| max: map.zoom | ||
| }; | ||
| } | ||
| }, | ||
| 'map-top-left-easting': { | ||
| type: 'range', | ||
| valueType: 'integer', | ||
| canBeNegative: true, | ||
| canBeZero: true, | ||
| get values() { | ||
| return [Math.trunc(map.extent.topLeft.pcrs.horizontal)]; | ||
| } | ||
| }, | ||
| 'map-top-left-northing': { | ||
| type: 'range', | ||
| valueType: 'integer', | ||
| canBeNegative: true, | ||
| canBeZero: true, | ||
| get values() { | ||
| return [Math.trunc(map.extent.topLeft.pcrs.vertical)]; | ||
| } | ||
| }, | ||
| 'map-bottom-right-easting': { | ||
| type: 'range', | ||
| valueType: 'integer', | ||
| canBeNegative: true, | ||
| canBeZero: true, | ||
| get values() { | ||
| return [Math.trunc(map.extent.bottomRight.pcrs.horizontal)]; | ||
| } | ||
| }, | ||
| 'map-bottom-right-northing': { | ||
| type: 'range', | ||
| valueType: 'integer', | ||
| canBeNegative: true, | ||
| canBeZero: true, | ||
| get values() { | ||
| return [Math.trunc(map.extent.bottomRight.pcrs.vertical)]; | ||
| } | ||
| }, | ||
| 'prefers-color-scheme': { | ||
| type: 'discrete', | ||
| get values() { | ||
| return [ | ||
| window.matchMedia('(prefers-color-scheme: dark)').matches | ||
| ? 'dark' | ||
| : 'light' | ||
| ]; | ||
| } | ||
| }, | ||
| 'prefers-map-content': { | ||
| type: 'discrete', | ||
| get values() { | ||
| return M.options.contentPreference; | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const solveUnknownFeature = (featureNode) => { | ||
| let feature = featureNode.feature; | ||
| let queryValue = featureNode.value.value; | ||
|
|
||
| if (feature === 'prefers-lang') { | ||
| return features['prefers-lang'].values.includes(queryValue).toString(); | ||
| } else if ( | ||
| feature === 'map-zoom' || | ||
| feature === 'map-top-left-easting' || | ||
| feature === 'map-top-left-northing' || | ||
| feature === 'map-bottom-right-easting' || | ||
| feature === 'map-bottom-right-northing' | ||
| ) { | ||
| return solveRangeFeature(featureNode); | ||
| } else if (feature === 'map-projection') { | ||
| return features['map-projection'].values | ||
| .some((p) => p === queryValue) | ||
| .toString(); | ||
| } else if (feature === 'prefers-color-scheme') { | ||
| return features['prefers-color-scheme'].values | ||
| .some((s) => s === queryValue) | ||
| .toString(); | ||
| } else if (feature === 'prefers-map-content') { | ||
| return features[feature].values | ||
| .some((pref) => pref === queryValue) | ||
| .toString(); | ||
| } | ||
| return 'false'; | ||
| }; | ||
| let matches = | ||
| solveMediaQueryList(parsedQuery, { | ||
| features, | ||
| solveUnknownFeature | ||
| }) === 'true' | ||
| ? true | ||
| : false; | ||
|
|
||
| function solveRangeFeature(featureNode) { | ||
| const { context, feature, value, op } = featureNode; | ||
|
|
||
| if (!feature.startsWith('map-')) { | ||
| return 'unknown'; | ||
| } | ||
|
|
||
| const currentValue = getMapFeatureValue(feature); | ||
|
|
||
| if (currentValue === undefined) { | ||
| return 'unknown'; | ||
| } | ||
|
|
||
| if (context === 'value') { | ||
| // Plain case: <mf-name>: <mf-value> | ||
| // Example: (map-zoom: 15) | ||
| return currentValue === value.value ? 'true' : 'false'; | ||
| } | ||
|
|
||
| if (context === 'range') { | ||
| // Range case: <mf-name> <mf-comparison> <mf-value> | ||
| // Example: (0 <= map-zoom < 15) | ||
| switch (op) { | ||
| case '<': | ||
| return currentValue < value.value ? 'true' : 'false'; | ||
| case '<=': | ||
| return currentValue <= value.value ? 'true' : 'false'; | ||
| case '>': | ||
| return currentValue > value.value ? 'true' : 'false'; | ||
| case '>=': | ||
| return currentValue >= value.value ? 'true' : 'false'; | ||
| case '=': | ||
| return currentValue === value.value ? 'true' : 'false'; | ||
| default: | ||
| return 'unknown'; | ||
| } | ||
| } | ||
|
|
||
| return 'unknown'; // If the context is neither "value" nor "range" | ||
| } | ||
|
|
||
| function getMapFeatureValue(feature) { | ||
| switch (feature) { | ||
| case 'map-zoom': | ||
| return map.zoom; | ||
| case 'map-top-left-easting': | ||
| return Math.trunc(map.extent.topLeft.pcrs.horizontal); | ||
| case 'map-top-left-northing': | ||
| return Math.trunc(map.extent.topLeft.pcrs.vertical); | ||
| case 'map-bottom-right-easting': | ||
| return Math.trunc(map.extent.bottomRight.pcrs.horizontal); | ||
| case 'map-bottom-right-northing': | ||
| return Math.trunc(map.extent.bottomRight.pcrs.vertical); | ||
| default: | ||
| return undefined; // Unsupported or unknown feature | ||
| } | ||
| } | ||
|
|
||
| // Make mediaQueryList an EventTarget for dispatching events | ||
| const mediaQueryList = Object.assign(new EventTarget(), { | ||
| matches, | ||
| media: query, | ||
| listeners: [], | ||
| // this is a client facing api | ||
| addEventListener(event, listener) { | ||
| if (event === 'change') { | ||
| this.listeners.push(listener); | ||
|
|
||
| // Start observing properties only if there is at least one listener | ||
| if (this.listeners.length !== 0) { | ||
| observeProperties(); | ||
| } | ||
| EventTarget.prototype.addEventListener.call(this, event, listener); | ||
| } | ||
| }, | ||
|
|
||
| // this is a client facing api | ||
| removeEventListener(event, listener) { | ||
| if (event === 'change') { | ||
| this.listeners = this.listeners.filter((l) => l !== listener); | ||
|
|
||
| // Stop observing if there are no more listeners | ||
| if (this.listeners.length === 0) { | ||
| stopObserving(); | ||
| } | ||
| EventTarget.prototype.removeEventListener.call(this, event, listener); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| const observeProperties = () => { | ||
| const notifyIfChanged = () => { | ||
| const newMatches = | ||
| solveMediaQueryList(parsedQuery, { | ||
| features, | ||
| solveUnknownFeature | ||
| }) === 'true' | ||
| ? true | ||
| : false; | ||
| if (newMatches !== mediaQueryList.matches) { | ||
| mediaQueryList.matches = newMatches; | ||
|
|
||
| // Dispatch a "change" event to notify listeners of the update | ||
| mediaQueryList.dispatchEvent(new Event('change')); | ||
| } | ||
| }; | ||
| notifyIfChanged.bind(this); | ||
| // Subscribe to internal events for changes in projection, zoom, and extent | ||
| this.addEventListener('map-projectionchange', notifyIfChanged); | ||
| this.addEventListener('map-moveend', notifyIfChanged); | ||
| const colorSchemeQuery = window.matchMedia('(prefers-color-scheme: dark)'); | ||
| colorSchemeQuery.addEventListener('change', notifyIfChanged); | ||
|
|
||
| // Stop observing function | ||
| stopObserving = () => { | ||
| this.removeEventListener('map-projectionchange', notifyIfChanged); | ||
| this.removeEventListener('map-moveend', notifyIfChanged); | ||
| colorSchemeQuery.removeEventListener('change', notifyIfChanged); | ||
| }; | ||
| }; | ||
|
|
||
| let stopObserving; // Declare here so it can be assigned within observeProperties | ||
|
|
||
| return mediaQueryList; | ||
| }; |
Oops, something went wrong.