From e1764385c32fce0eb45453fb194f80da568ff602 Mon Sep 17 00:00:00 2001
From: Dominic Go <18517029+dominicstop@users.noreply.github.com>
Date: Sat, 20 Nov 2021 23:56:12 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=92=AB=20Update=20`MenuConfig`=20To=20Use?=
 =?UTF-8?q?=20`ImageItemConfig`?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/types/ImageItemConfig.ts |  7 +++++++
 src/types/MenuConfig.ts      | 21 ++++++++++++++++-----
 2 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/src/types/ImageItemConfig.ts b/src/types/ImageItemConfig.ts
index e668d1b..e89ef43 100644
--- a/src/types/ImageItemConfig.ts
+++ b/src/types/ImageItemConfig.ts
@@ -92,6 +92,13 @@ export type ImageGradientConfig = Partial<Pick<ImageRectConfig,
   type?: 'axial' | 'conic' | 'radial'
 };
 
+/**
+ * A configuration object for images.
+ * 
+ * This configuration object is used to either programmatically create images,
+ * (e.g. gradients, rects, SFSymbols icons, etc)., or refer to existing image assets
+ * in the project (e.g. js image assets, XCAssets).
+ */
 export type ImageItemConfig = {
   type: 'IMAGE_ASSET';
   /** The corresponding key of asset item in the asset catalog */
diff --git a/src/types/MenuConfig.ts b/src/types/MenuConfig.ts
index e5feed1..f219acf 100644
--- a/src/types/MenuConfig.ts
+++ b/src/types/MenuConfig.ts
@@ -29,15 +29,26 @@ export type MenuActionConfig = {
   menuAttributes?: MenuAttributes;
 
   discoverabilityTitle?: string;
-  icon?: IconConfig;
-  
-  // subtitle - TODO: TBA
+
+  /**
+   * `IconConfig` is deprecated, use `ImageItemConfig` instead.
+   * Used to configure what icon or image to show in the menu action.
+   */
+  icon?: IconConfig | ImageItemConfig;
 };
 
 export type MenuConfig = {
   menuTitle: string;
-  
+
   menuOptions?: Array<UIMenuOptions>;
   menuItems?: Array<MenuConfig | MenuActionConfig>;
-  icon?: IconConfig;
+
+  /**
+   * `IconConfig` is deprecated, use `ImageItemConfig` instead.
+   * Used to configure what icon or image to show in the submenu.
+   * 
+   * Note: The icon is only shown if the menu is a submenu. If the menu
+   * is the root menu, the icon will not be visible.
+   */
+  icon?: IconConfig | ImageItemConfig;
 };
\ No newline at end of file