Patch Media: Remove event-listenever package and replaced with local …

…function (#611)
solidjs-community · Apr 9, 2024 · 3ab84fe · 3ab84fe
2 parents 75c8762 + 5e1dd94
commit 3ab84fe
Show file tree

Hide file tree

Showing 5 changed files with 2,185 additions and 2,278 deletions.
diff --git a/packages/media/CHANGELOG.md b/packages/media/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @solid-primitives/media
 
+## 2.2.9
+
+### Patch Changes
+
+- Added warning regarding iOS13 support and instruction on how to polyfill
+
 ## 2.2.8
 
 ### Patch Changes
@@ -257,5 +263,3 @@ Added `makeMediaQueryListener`, implementation improvements
 2.0.0
 
 Add `usePrefersDark`.
-
-Remove the default export. (`createMediaQuery` will only be available as named export)
diff --git a/packages/media/README.md b/packages/media/README.md
@@ -200,10 +200,26 @@ createEffect(() => {
 
 > Note: `usePrefersDark` will deopt to `createPrefersDark` if used during hydration. (see issue [#310](https://github.com/solidjs-community/solid-primitives/issues/310))
 
+## Notes
+### iOS 13 Support & Deprecated `addListener`
+
+Due to older versions of [mobile Safari on iOS 13 not supporting](https://github.com/mdn/sprints/issues/858) `addEventListener` on the MediaQueryList API, this primitive will need to be polyfilled. If your application needs to support much older versions of the browser you should [use a polyfill utility](https://www.npmjs.com/package/matchmedia-polyfill) or patch the missing function like so:
+
+```ts
+if (!'addEventListener' in MediaQueryList) {
+  MediaQueryList.prototype.addEventListener = function(type, callback) {
+    if (type === "change") this.addListener(callback)
+  }
+  MediaQueryList.prototype.removeEventListener = function(type, callback) {
+    if (type === "change") this.removeListener(callback)
+  }
+}
+```
 ## Changelog
 
 See [CHANGELOG.md](./CHANGELOG.md)
 
 ## Contributors
 
 Thanks to Aditya Agarwal for contributing createBreakpoints.
+
diff --git a/packages/media/package.json b/packages/media/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@solid-primitives/media",
-  "version": "2.2.8",
+  "version": "2.2.9",
   "description": "Primitives for media query and device features",
   "author": "David Di Biase <dave.dibiase@gmail.com>",
   "contributors": [

diff --git a/packages/media/src/index.ts b/packages/media/src/index.ts
@@ -176,4 +176,4 @@ export function sortBreakpoints(breakpoints: Breakpoints): Breakpoints {
     obj[key] = value;
     return obj;
   }, {});
-}
+}
-Original file line number
+Diff line change
@@ Expand Up @@
         obj[key] = value;
         return obj;
       }, {});
-    }
+    }