expo-app-icon 1.1.0 → 1.3.0

package/README.md

@@ -3,7 +3,7 @@
 </div>
   
 # Expo App Icon
-Programmatically change your app's icon at runtime in Expo, with proper Android adaptive-icon support.
+Programmatically change your app's icon at runtime in Expo.
 
 ## Install
 
@@ -31,19 +31,26 @@ Add the plugin to your `app.json` config and declare your icons. Each icon is ju
 }
 ```
 
-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:
+The same image is used for both platforms. For per-platform images, or to attach
+metadata (any key/value you want — labels, descriptions, premium flags, …), use the object form:
 
 ```json
 {
   "red": "./assets/icons/red.png",
   "blue": {
-    "ios": "./assets/icons/blue-ios.png",
-    "android": "./assets/icons/blue-android.png",
-    "prerendered": true
+    "image": "./assets/icons/blue.png",
+    "metadata": { "label": "Blue", "description": "Cool blue", "isPremium": true }
+  },
+  "split": {
+    "ios": "./assets/icons/split-ios.png",
+    "android": "./assets/icons/split-android.png"
   }
 }
 ```
 
+- `image` sets both platforms; `ios` / `android` override it per platform.
+- `metadata` is passed straight through to `getAvailableIcons()` at runtime (it's ignored when generating the icons).
+
 Then create a new build (the plugin runs during prebuild):
 
 ```sh
@@ -52,15 +59,35 @@ npx expo prebuild --clean
 
 ## Usage
 
+Build a picker with the `useAppIcon` hook and `getAvailableIcons` — no per-app boilerplate or persistence needed (the native module is the source of truth):
+
+```tsx
+import { useAppIcon, getAvailableIcons } from "expo-app-icon";
+
+type Meta = { label: string; description?: string; isPremium?: boolean };
+
+function IconPicker() {
+  const { icon, setIcon, isDefault } = useAppIcon();
+
+  return getAvailableIcons<Meta>().map(({ name, metadata }) => (
+    <Pressable key={name} onPress={() => setIcon(name)}>
+      <Text>{metadata.label}{icon === name ? " ✓" : ""}</Text>
+    </Pressable>
+  ));
+}
+```
+
+- `icon` — the current icon key, or `null` for the default.
+- `setIcon(name | null)` — switch icons; pass `null` to reset to the default. (The iOS timing fix is built in.)
+- `isDefault` / `isSupported` — handy flags (`isSupported` is `false` on web).
+- `getAvailableIcons<Meta>()` — the configured icons + their metadata, typed to `Meta`.
+
+Or call the underlying functions directly:
+
 ```ts
 import { getAppIcon, setAppIcon } from "expo-app-icon";
 
-// Get the name of the current icon ("DEFAULT" when none is set)
-const current = getAppIcon();
-
-// Switch to one of your configured icons by key
+const current = getAppIcon(); // icon name, or "DEFAULT"
 setAppIcon("red");
-
-// Reset back to the default icon
-setAppIcon(null);
+setAppIcon(null); // reset to default
 ```

package/build/icons-data.d.ts

@@ -0,0 +1,19 @@
+import type { DynamicAppIconRegistry } from "./types";
+type IconName = DynamicAppIconRegistry["IconName"];
+/**
+ * One configured icon and the metadata declared for it in the plugin config.
+ */
+export type AppIconEntry<M = Record<string, unknown>> = {
+    /** The configured icon key. */
+    name: IconName;
+    /** Arbitrary metadata attached in app.json (label, description, isPremium, …). */
+    metadata: M;
+};
+/**
+ * The icons configured in app.json, with their metadata. Generic over the
+ * consumer's metadata shape, e.g.
+ * `getAvailableIcons<{ label: string; isPremium?: boolean }>()`.
+ */
+export declare function getAvailableIcons<M = Record<string, unknown>>(): AppIconEntry<M>[];
+export {};
+//# sourceMappingURL=icons-data.d.ts.map

package/build/icons-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons-data.d.ts","sourceRoot":"","sources":["../src/icons-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtD,KAAK,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACtD,+BAA+B;IAC/B,IAAI,EAAE,QAAQ,CAAC;IACf,kFAAkF;IAClF,QAAQ,EAAE,CAAC,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KACxB,YAAY,CAAC,CAAC,CAAC,EAAE,CAErB"}

package/build/icons-data.generated.d.ts

@@ -0,0 +1,7 @@
+import type { AppIconEntry } from "./icons-data";
+/**
+ * Placeholder. The expo-app-icon config plugin overwrites this file's compiled
+ * output during prebuild with the icons + metadata declared in app.json.
+ */
+export declare const ICON_DATA: AppIconEntry[];
+//# sourceMappingURL=icons-data.generated.d.ts.map

package/build/icons-data.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons-data.generated.d.ts","sourceRoot":"","sources":["../src/icons-data.generated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,YAAY,EAAO,CAAC"}

package/build/icons-data.generated.js

@@ -0,0 +1,6 @@
+/**
+ * Placeholder. The expo-app-icon config plugin overwrites this file's compiled
+ * output during prebuild with the icons + metadata declared in app.json.
+ */
+export const ICON_DATA = [];
+//# sourceMappingURL=icons-data.generated.js.map

package/build/icons-data.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons-data.generated.js","sourceRoot":"","sources":["../src/icons-data.generated.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAmB,EAAE,CAAC","sourcesContent":["import type { AppIconEntry } from \"./icons-data\";\n\n/**\n * Placeholder. The expo-app-icon config plugin overwrites this file's compiled\n * output during prebuild with the icons + metadata declared in app.json.\n */\nexport const ICON_DATA: AppIconEntry[] = [];\n"]}

package/build/icons-data.js

@@ -0,0 +1,10 @@
+import { ICON_DATA } from "./icons-data.generated";
+/**
+ * The icons configured in app.json, with their metadata. Generic over the
+ * consumer's metadata shape, e.g.
+ * `getAvailableIcons<{ label: string; isPremium?: boolean }>()`.
+ */
+export function getAvailableIcons() {
+    return ICON_DATA;
+}
+//# sourceMappingURL=icons-data.js.map

package/build/icons-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icons-data.js","sourceRoot":"","sources":["../src/icons-data.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAcnD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAG/B,OAAO,SAAyC,CAAC;AACnD,CAAC","sourcesContent":["import type { DynamicAppIconRegistry } from \"./types\";\nimport { ICON_DATA } from \"./icons-data.generated\";\n\ntype IconName = DynamicAppIconRegistry[\"IconName\"];\n\n/**\n * One configured icon and the metadata declared for it in the plugin config.\n */\nexport type AppIconEntry<M = Record<string, unknown>> = {\n  /** The configured icon key. */\n  name: IconName;\n  /** Arbitrary metadata attached in app.json (label, description, isPremium, …). */\n  metadata: M;\n};\n\n/**\n * The icons configured in app.json, with their metadata. Generic over the\n * consumer's metadata shape, e.g.\n * `getAvailableIcons<{ label: string; isPremium?: boolean }>()`.\n */\nexport function getAvailableIcons<\n  M = Record<string, unknown>\n>(): AppIconEntry<M>[] {\n  return ICON_DATA as unknown as AppIconEntry<M>[];\n}\n"]}

package/build/index.d.ts

@@ -1,4 +1,8 @@
 import type { DynamicAppIconRegistry } from "./types";
+export { useAppIcon } from "./useAppIcon";
+export type { UseAppIcon } from "./useAppIcon";
+export { getAvailableIcons } from "./icons-data";
+export type { AppIconEntry } from "./icons-data";
 /**
  * Union of the icon keys declared in the plugin config (widened to string when none).
  */

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,YAAY,EAAG,SAAkB,CAAC;AAE/C;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,QAAQ,GAAG,IAAI,GACpB,QAAQ,GAAG,OAAO,YAAY,GAAG,KAAK,CAExC;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,QAAQ,GAAG,OAAO,YAAY,CAE3D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,YAAY,EAAG,SAAkB,CAAC;AAE/C;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,QAAQ,GAAG,IAAI,GACpB,QAAQ,GAAG,OAAO,YAAY,GAAG,KAAK,CAExC;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,QAAQ,GAAG,OAAO,YAAY,CAE3D"}

package/build/index.js

@@ -1,4 +1,6 @@
 import NativeAppIcon from "./ExpoAppIconChangerModule";
+export { useAppIcon } from "./useAppIcon";
+export { getAvailableIcons } from "./icons-data";
 /**
  * Value reported / accepted for the project's default launcher icon.
  */

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAOvD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,SAAkB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,IAAqB;IAErB,OAAO,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,aAAa,CAAC,UAAU,EAAE,CAAC;AACpC,CAAC","sourcesContent":["import type { DynamicAppIconRegistry } from \"./types\";\nimport NativeAppIcon from \"./ExpoAppIconChangerModule\";\n\n/**\n * Union of the icon keys declared in the plugin config (widened to string when none).\n */\nexport type IconName = DynamicAppIconRegistry[\"IconName\"];\n\n/**\n * Value reported / accepted for the project's default launcher icon.\n */\nexport const DEFAULT_ICON = \"DEFAULT\" as const;\n\n/**\n * Switch the launcher icon at runtime.\n *\n * @param name A configured icon key, or `null` to reset to the default icon.\n * @returns The applied icon name, `\"DEFAULT\"`, or `false` if unsupported.\n */\nexport function setAppIcon(\n  name: IconName | null\n): IconName | typeof DEFAULT_ICON | false {\n  return NativeAppIcon.setAppIcon(name);\n}\n\n/**\n * Get the currently active icon name, or `\"DEFAULT\"` when none is set.\n */\nexport function getAppIcon(): IconName | typeof DEFAULT_ICON {\n  return NativeAppIcon.getAppIcon();\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAQjD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,SAAkB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,IAAqB;IAErB,OAAO,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,aAAa,CAAC,UAAU,EAAE,CAAC;AACpC,CAAC","sourcesContent":["import type { DynamicAppIconRegistry } from \"./types\";\nimport NativeAppIcon from \"./ExpoAppIconChangerModule\";\n\nexport { useAppIcon } from \"./useAppIcon\";\nexport type { UseAppIcon } from \"./useAppIcon\";\nexport { getAvailableIcons } from \"./icons-data\";\nexport type { AppIconEntry } from \"./icons-data\";\n\n/**\n * Union of the icon keys declared in the plugin config (widened to string when none).\n */\nexport type IconName = DynamicAppIconRegistry[\"IconName\"];\n\n/**\n * Value reported / accepted for the project's default launcher icon.\n */\nexport const DEFAULT_ICON = \"DEFAULT\" as const;\n\n/**\n * Switch the launcher icon at runtime.\n *\n * @param name A configured icon key, or `null` to reset to the default icon.\n * @returns The applied icon name, `\"DEFAULT\"`, or `false` if unsupported.\n */\nexport function setAppIcon(\n  name: IconName | null\n): IconName | typeof DEFAULT_ICON | false {\n  return NativeAppIcon.setAppIcon(name);\n}\n\n/**\n * Get the currently active icon name, or `\"DEFAULT\"` when none is set.\n */\nexport function getAppIcon(): IconName | typeof DEFAULT_ICON {\n  return NativeAppIcon.getAppIcon();\n}\n"]}

package/build/index.web.d.ts

@@ -1,6 +1,14 @@
 import type { DynamicAppIconRegistry } from "./types";
+import type { UseAppIcon } from "./useAppIcon";
+export { getAvailableIcons } from "./icons-data";
+export type { AppIconEntry } from "./icons-data";
+export type { UseAppIcon } from "./useAppIcon";
 export type IconName = DynamicAppIconRegistry["IconName"];
 export declare const DEFAULT_ICON: "DEFAULT";
+/**
+ * Web has no launcher icon; the hook reports an unsupported, default state.
+ */
+export declare function useAppIcon(): UseAppIcon;
 /**
  * Web has no launcher icon; this is a no-op that reports failure.
  */

package/build/index.web.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.web.d.ts","sourceRoot":"","sources":["../src/index.web.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,MAAM,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAE1D,eAAO,MAAM,YAAY,EAAG,SAAkB,CAAC;AAE/C;;GAEG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,QAAQ,GAAG,IAAI,GACrB,QAAQ,GAAG,OAAO,YAAY,GAAG,KAAK,CAGxC;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,QAAQ,GAAG,OAAO,YAAY,CAG3D"}
+{"version":3,"file":"index.web.d.ts","sourceRoot":"","sources":["../src/index.web.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAE1D,eAAO,MAAM,YAAY,EAAG,SAAkB,CAAC;AAE/C;;GAEG;AACH,wBAAgB,UAAU,IAAI,UAAU,CAEvC;AAED;;GAEG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,QAAQ,GAAG,IAAI,GACrB,QAAQ,GAAG,OAAO,YAAY,GAAG,KAAK,CAGxC;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,QAAQ,GAAG,OAAO,YAAY,CAG3D"}

package/build/index.web.js

@@ -1,4 +1,11 @@
+export { getAvailableIcons } from "./icons-data";
 export const DEFAULT_ICON = "DEFAULT";
+/**
+ * Web has no launcher icon; the hook reports an unsupported, default state.
+ */
+export function useAppIcon() {
+    return { icon: null, setIcon: () => { }, isDefault: true, isSupported: false };
+}
 /**
  * Web has no launcher icon; this is a no-op that reports failure.
  */

package/build/index.web.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.web.js","sourceRoot":"","sources":["../src/index.web.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,YAAY,GAAG,SAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,KAAsB;IAEtB,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpD,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import type { DynamicAppIconRegistry } from \"./types\";\n\nexport type IconName = DynamicAppIconRegistry[\"IconName\"];\n\nexport const DEFAULT_ICON = \"DEFAULT\" as const;\n\n/**\n * Web has no launcher icon; this is a no-op that reports failure.\n */\nexport function setAppIcon(\n  _name: IconName | null\n): IconName | typeof DEFAULT_ICON | false {\n  console.error(\"setAppIcon is not supported on web\");\n  return false;\n}\n\n/**\n * Web has no launcher icon; always reports the default.\n */\nexport function getAppIcon(): IconName | typeof DEFAULT_ICON {\n  console.error(\"getAppIcon is not supported on web\");\n  return DEFAULT_ICON;\n}\n"]}
+{"version":3,"file":"index.web.js","sourceRoot":"","sources":["../src/index.web.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAMjD,MAAM,CAAC,MAAM,YAAY,GAAG,SAAkB,CAAC;AAE/C;;GAEG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AAChF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,KAAsB;IAEtB,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpD,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import type { DynamicAppIconRegistry } from \"./types\";\nimport type { UseAppIcon } from \"./useAppIcon\";\n\nexport { getAvailableIcons } from \"./icons-data\";\nexport type { AppIconEntry } from \"./icons-data\";\nexport type { UseAppIcon } from \"./useAppIcon\";\n\nexport type IconName = DynamicAppIconRegistry[\"IconName\"];\n\nexport const DEFAULT_ICON = \"DEFAULT\" as const;\n\n/**\n * Web has no launcher icon; the hook reports an unsupported, default state.\n */\nexport function useAppIcon(): UseAppIcon {\n  return { icon: null, setIcon: () => {}, isDefault: true, isSupported: false };\n}\n\n/**\n * Web has no launcher icon; this is a no-op that reports failure.\n */\nexport function setAppIcon(\n  _name: IconName | null\n): IconName | typeof DEFAULT_ICON | false {\n  console.error(\"setAppIcon is not supported on web\");\n  return false;\n}\n\n/**\n * Web has no launcher icon; always reports the default.\n */\nexport function getAppIcon(): IconName | typeof DEFAULT_ICON {\n  console.error(\"getAppIcon is not supported on web\");\n  return DEFAULT_ICON;\n}\n"]}

package/build/useAppIcon.d.ts

@@ -0,0 +1,20 @@
+import type { DynamicAppIconRegistry } from "./types";
+type IconName = DynamicAppIconRegistry["IconName"];
+export type UseAppIcon = {
+    /** Current icon; `null` means the default icon. */
+    icon: IconName | null;
+    /** Set the icon, or pass `null` to reset to the default. */
+    setIcon: (name: IconName | null) => void;
+    /** Whether the current icon is the default. */
+    isDefault: boolean;
+    /** Whether changing the icon is supported on this platform. */
+    isSupported: boolean;
+};
+/**
+ * React hook for the app's launcher icon. The native module is the source of
+ * truth (the value survives the app restart an Android change triggers), so no
+ * extra persistence is needed.
+ */
+export declare function useAppIcon(): UseAppIcon;
+export {};
+//# sourceMappingURL=useAppIcon.d.ts.map

package/build/useAppIcon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppIcon.d.ts","sourceRoot":"","sources":["../src/useAppIcon.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEtD,KAAK,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAWnD,MAAM,MAAM,UAAU,GAAG;IACvB,mDAAmD;IACnD,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,4DAA4D;IAC5D,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC;IACzC,+CAA+C;IAC/C,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,UAAU,CAuBvC"}

package/build/useAppIcon.js

@@ -0,0 +1,40 @@
+import { useCallback, useState } from "react";
+import NativeAppIcon from "./ExpoAppIconChangerModule";
+/**
+ * Read the current icon from the native module, normalising the default
+ * (`"DEFAULT"`) to `null`.
+ */
+function readCurrentIcon() {
+    const current = NativeAppIcon.getAppIcon();
+    return current === "DEFAULT" ? null : current;
+}
+/**
+ * React hook for the app's launcher icon. The native module is the source of
+ * truth (the value survives the app restart an Android change triggers), so no
+ * extra persistence is needed.
+ */
+export function useAppIcon() {
+    const [icon, setIconState] = useState(() => {
+        try {
+            return readCurrentIcon();
+        }
+        catch {
+            return null;
+        }
+    });
+    const setIcon = useCallback((name) => {
+        // Defer so any parent re-render (e.g. a menu closing) settles before the
+        // native call, which can present a system alert / restart the app.
+        setTimeout(() => {
+            try {
+                NativeAppIcon.setAppIcon(name);
+                setIconState(name);
+            }
+            catch (error) {
+                console.error("Failed to set app icon:", error);
+            }
+        }, 0);
+    }, []);
+    return { icon, setIcon, isDefault: icon === null, isSupported: true };
+}
+//# sourceMappingURL=useAppIcon.js.map

package/build/useAppIcon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppIcon.js","sourceRoot":"","sources":["../src/useAppIcon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE9C,OAAO,aAAa,MAAM,4BAA4B,CAAC;AAKvD;;;GAGG;AACH,SAAS,eAAe;IACtB,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;IAC3C,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,OAAoB,CAAC;AAC9D,CAAC;AAaD;;;;GAIG;AACH,MAAM,UAAU,UAAU;IACxB,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAkB,GAAG,EAAE;QAC1D,IAAI,CAAC;YACH,OAAO,eAAe,EAAE,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,IAAqB,EAAE,EAAE;QACpD,yEAAyE;QACzE,mEAAmE;QACnE,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,CAAC;gBACH,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,KAAK,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;AACxE,CAAC","sourcesContent":["import { useCallback, useState } from \"react\";\n\nimport NativeAppIcon from \"./ExpoAppIconChangerModule\";\nimport type { DynamicAppIconRegistry } from \"./types\";\n\ntype IconName = DynamicAppIconRegistry[\"IconName\"];\n\n/**\n * Read the current icon from the native module, normalising the default\n * (`\"DEFAULT\"`) to `null`.\n */\nfunction readCurrentIcon(): IconName | null {\n  const current = NativeAppIcon.getAppIcon();\n  return current === \"DEFAULT\" ? null : (current as IconName);\n}\n\nexport type UseAppIcon = {\n  /** Current icon; `null` means the default icon. */\n  icon: IconName | null;\n  /** Set the icon, or pass `null` to reset to the default. */\n  setIcon: (name: IconName | null) => void;\n  /** Whether the current icon is the default. */\n  isDefault: boolean;\n  /** Whether changing the icon is supported on this platform. */\n  isSupported: boolean;\n};\n\n/**\n * React hook for the app's launcher icon. The native module is the source of\n * truth (the value survives the app restart an Android change triggers), so no\n * extra persistence is needed.\n */\nexport function useAppIcon(): UseAppIcon {\n  const [icon, setIconState] = useState<IconName | null>(() => {\n    try {\n      return readCurrentIcon();\n    } catch {\n      return null;\n    }\n  });\n\n  const setIcon = useCallback((name: IconName | null) => {\n    // Defer so any parent re-render (e.g. a menu closing) settles before the\n    // native call, which can present a system alert / restart the app.\n    setTimeout(() => {\n      try {\n        NativeAppIcon.setAppIcon(name);\n        setIconState(name);\n      } catch (error) {\n        console.error(\"Failed to set app icon:\", error);\n      }\n    }, 0);\n  }, []);\n\n  return { icon, setIcon, isDefault: icon === null, isSupported: true };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-app-icon",
-  "version": "1.1.0",
+  "version": "1.3.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/apple.js

@@ -74,7 +74,6 @@ const withAppleAlternateIcons = (config, props) => {
                 return;
             const entry = {
                 CFBundleIconFiles: [(0, icons_1.appleIconBaseName)(iconKey, variant)],
-                UIPrerenderedIcon: !!icon.prerendered,
             };
             if (variant.target) {
                 (iconsByTarget[variant.target] ??= {})[iconKey] = entry;

package/plugin/build/icons.d.ts

@@ -2,7 +2,9 @@ import type { AppleIconVariant, IconConfig, IconPluginInput, IconSet, ResolvedIc
 /**
  * Coerce whatever the user placed in app config into a normalized icon map.
  * A bare array of image paths is expanded to keyed entries that share the same
- * image for both platforms.
+ * image for both platforms. For the object form, the `image` convenience is
+ * expanded to `ios`/`android` (which override it) and `metadata` is carried
+ * through untouched.
  */
 export declare function normalizeIconSet(input: IconPluginInput): IconSet;
 /**

package/plugin/build/icons.js

@@ -14,7 +14,9 @@ const APPLE_ICON_BLUEPRINTS = [
 /**
  * Coerce whatever the user placed in app config into a normalized icon map.
  * A bare array of image paths is expanded to keyed entries that share the same
- * image for both platforms.
+ * image for both platforms. For the object form, the `image` convenience is
+ * expanded to `ios`/`android` (which override it) and `metadata` is carried
+ * through untouched.
  */
 function normalizeIconSet(input) {
     if (Array.isArray(input)) {
@@ -25,11 +27,19 @@ function normalizeIconSet(input) {
     }
     if (!input)
         return {};
-    return Object.fromEntries(Object.entries(input).map(([key, value]) => [
-        key,
+    return Object.fromEntries(Object.entries(input).map(([key, value]) => {
         // String shorthand: one image path used for both platforms.
-        typeof value === "string" ? { ios: value, android: value } : value,
-    ]));
+        if (typeof value === "string") {
+            return [key, { ios: value, android: value }];
+        }
+        const { image, ios, android, metadata } = value;
+        const config = {
+            ios: ios ?? image,
+            android: android ?? image,
+            ...(metadata ? { metadata } : {}),
+        };
+        return [key, config];
+    }));
 }
 /**
  * Build the list of Apple icon variants to emit for the given tablet support.

package/plugin/build/index.js

@@ -17,7 +17,7 @@ const withDynamicIcon = (config, input) => {
     const icons = (0, icons_1.normalizeIconSet)(input);
     const variants = (0, icons_1.resolveAppleVariants)(Boolean(config.ios?.supportsTablet));
     const props = { icons, variants };
-    config = withTypedIconNames(config, icons);
+    config = withGeneratedIconData(config, icons);
     config = (0, apple_1.withAppleIconAssets)(config, props);
     config = (0, apple_1.withAppleAlternateIcons)(config, props);
     config = (0, apple_1.withAppleIconImages)(config, props);
@@ -26,13 +26,17 @@ const withDynamicIcon = (config, input) => {
     return config;
 };
 /**
- * Rewrite the shipped `IconName` union in `build/types.d.ts` to the configured
- * icon keys, so `getAppIcon()` / `setAppIcon()` are typed to this project.
+ * Sync the shipped package to this project's icons:
+ *  - rewrite the `IconName` union in `build/types.d.ts` so `getAppIcon()` /
+ *    `setAppIcon()` / `getAvailableIcons()` are typed to the configured keys, and
+ *  - emit the `{ name, metadata }` list into `build/icons-data.generated.js` so
+ *    `getAvailableIcons()` returns it at runtime.
+ *
+ * Both files only exist in a built package, so writes are best-effort.
  */
-function withTypedIconNames(config, icons) {
-    const union = Object.keys(icons)
-        .map((name) => `"${name}"`)
-        .join(" | ") || "string";
+function withGeneratedIconData(config, icons) {
+    const names = Object.keys(icons);
+    const union = names.map((name) => `"${name}"`).join(" | ") || "string";
     const typesFile = path_1.default.join(PACKAGE_ROOT, "build", "types.d.ts");
     try {
         const current = fs_1.default.readFileSync(typesFile, "utf8");
@@ -41,6 +45,17 @@ function withTypedIconNames(config, icons) {
     catch {
         // The types file only exists in a built package; ignore when absent.
     }
+    const iconData = names.map((name) => ({
+        name,
+        metadata: icons[name]?.metadata ?? {},
+    }));
+    const dataFile = path_1.default.join(PACKAGE_ROOT, "build", "icons-data.generated.js");
+    try {
+        fs_1.default.writeFileSync(dataFile, `export const ICON_DATA = ${JSON.stringify(iconData)};\n`);
+    }
+    catch {
+        // The build output only exists in a built package; ignore when absent.
+    }
     return config;
 }
 exports.default = withDynamicIcon;

package/plugin/build/types.d.ts

@@ -1,5 +1,11 @@
 /**
- * A single icon entry as declared in the plugin config.
+ * Arbitrary, JSON-serialisable metadata a consumer attaches to an icon (e.g.
+ * label, description, isPremium). Surfaced at runtime via getAvailableIcons().
+ */
+export type IconMetadata = Record<string, unknown>;
+/**
+ * A normalized icon entry as used everywhere internally (the `image`
+ * convenience has been expanded to `ios`/`android`).
  */
 export type IconConfig = {
     /**
@@ -11,20 +17,28 @@ export type IconConfig = {
      */
     android?: string;
     /**
-     * Whether iOS should treat the icon as already rendered (no gloss).
+     * Display/behaviour metadata, passed through to runtime untouched.
      */
-    prerendered?: boolean;
+    metadata?: IconMetadata;
 };
 /**
  * Map of icon key → icon config, as used everywhere internally (always the
  * fully-resolved object form).
  */
 export type IconSet = Record<string, IconConfig>;
+/**
+ * The object form a consumer may declare. Adds `image` as a convenience that
+ * sets both platforms (`ios`/`android` override it when present).
+ */
+export type IconInputObject = IconConfig & {
+    /** Single image used for both platforms (shorthand for ios + android). */
+    image?: string;
+};
 /**
  * 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.
+ * platforms (`"red": "./assets/red.png"`) or the explicit object form.
  */
-export type IconInput = string | IconConfig;
+export type IconInput = string | IconInputObject;
 /**
  * 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.