expo-app-icon 1.0.0 → 1.1.0

package/README.md

@@ -1,5 +1,8 @@
-# expo-app-icon
-
+<div align="center">
+  <img src="https://raw.githubusercontent.com/Daniel-Griffiths/expo-app-icon/master/assets/icon.png" width="128" alt="expo-app-icon" />
+</div>
+  
+# Expo App Icon
 Programmatically change your app's icon at runtime in Expo, with proper Android adaptive-icon support.
 
 ## Install
@@ -10,7 +13,7 @@ npx expo install expo-app-icon
 
 ## Configure
 
-Add the plugin to your app config and declare your icons. Each icon needs an `ios` and/or `android` image path:
+Add the plugin to your `app.json` config and declare your icons. Each icon is just a key and an image path:
 
 ```json
 {
@@ -19,14 +22,8 @@ Add the plugin to your app config and declare your icons. Each icon needs an `io
       [
         "expo-app-icon",
         {
-          "red": {
-            "ios": "./assets/icons/red.png",
-            "android": "./assets/icons/red.png"
-          },
-          "blue": {
-            "ios": "./assets/icons/blue.png",
-            "android": "./assets/icons/blue.png"
-          }
+          "red": "./assets/icons/red.png",
+          "blue": "./assets/icons/blue.png"
         }
       ]
     ]
@@ -34,6 +31,19 @@ Add the plugin to your app config and declare your icons. Each icon needs an `io
 }
 ```
 
+The same image is used for both platforms. To use a different image per platform (or mark an iOS icon as prerendered), pass an object instead:
+
+```json
+{
+  "red": "./assets/icons/red.png",
+  "blue": {
+    "ios": "./assets/icons/blue-ios.png",
+    "android": "./assets/icons/blue-android.png",
+    "prerendered": true
+  }
+}
+```
+
 Then create a new build (the plugin runs during prebuild):
 
 ```sh
@@ -54,9 +64,3 @@ setAppIcon("red");
 // Reset back to the default icon
 setAppIcon(null);
 ```
-
-## Notes
-
-- Icon keys are the keys you define in the plugin config.
-- Android icons are generated as adaptive icons. Source images are scaled into the adaptive safe zone, so design your artwork edge-to-edge — it will be centered automatically.
-- Changing the icon on Android briefly closes and reopens the app.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-app-icon",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Programmatically change the app icon at runtime in Expo, with Android adaptive-icon support.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/plugin/build/icons.js

@@ -23,7 +23,13 @@ function normalizeIconSet(input) {
             return acc;
         }, {});
     }
-    return input ?? {};
+    if (!input)
+        return {};
+    return Object.fromEntries(Object.entries(input).map(([key, value]) => [
+        key,
+        // String shorthand: one image path used for both platforms.
+        typeof value === "string" ? { ios: value, android: value } : value,
+    ]));
 }
 /**
  * Build the list of Apple icon variants to emit for the given tablet support.

package/plugin/build/types.d.ts

@@ -16,14 +16,20 @@ export type IconConfig = {
     prerendered?: boolean;
 };
 /**
- * Map of icon key → icon config, as used everywhere internally.
+ * Map of icon key → icon config, as used everywhere internally (always the
+ * fully-resolved object form).
  */
 export type IconSet = Record<string, IconConfig>;
 /**
- * What the plugin accepts from the app config: a keyed map, a bare list of
- * image paths, or nothing.
+ * An icon as declared by the user: either a single image path used for both
+ * platforms (`"red": "./assets/red.png"`) or the explicit per-platform object.
  */
-export type IconPluginInput = IconSet | string[] | void;
+export type IconInput = string | IconConfig;
+/**
+ * What the plugin accepts from the app config: a keyed map (string shorthand or
+ * object per icon), a bare list of image paths, or nothing.
+ */
+export type IconPluginInput = Record<string, IconInput> | string[] | void;
 /**
  * Device family an Apple icon variant targets.
  */