feat(splash screen) add taskbarIcon property for splash screen wind…

…ow (#673)
built-on-openfin · Jan 24, 2024 · a79b8d0 · a79b8d0
1 parent 2d45521
commit a79b8d0
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 0 deletions.
diff --git a/how-to/workspace-platform-starter/CHANGELOG.md b/how-to/workspace-platform-starter/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## v17.0.0
 
 - Added support for dock submenus
+- Added support for customizing the taskbar icon for the splash screen window
 
 ## v16.1.0
 

diff --git a/how-to/workspace-platform-starter/client/src/framework/platform/platform-splash.ts b/how-to/workspace-platform-starter/client/src/framework/platform/platform-splash.ts
@@ -78,6 +78,7 @@ export async function open(): Promise<void> {
 				resizable: false,
 				saveWindowState: false,
 				showTaskbarIcon: true,
+				icon: customSettings?.splashScreenProvider?.taskbarIcon ?? icon,
 				customData: {
 					channelName,
 					style: {

diff --git a/how-to/workspace-platform-starter/client/src/framework/shapes/splash-shapes.ts b/how-to/workspace-platform-starter/client/src/framework/shapes/splash-shapes.ts
@@ -46,4 +46,9 @@ export interface SplashScreenProviderOptions {
 	 * The border color, defaults to theme border.
 	 */
 	borderColor?: string;
+
+	/**
+	 * The taskbar icon. Falls back to icon if not provided.
+	 */
+	taskbarIcon?: string;
 }
diff --git a/how-to/workspace-platform-starter/client/types/module/shapes/splash-shapes.d.ts b/how-to/workspace-platform-starter/client/types/module/shapes/splash-shapes.d.ts
@@ -38,4 +38,8 @@ export interface SplashScreenProviderOptions {
 	 * The border color, defaults to theme border.
 	 */
 	borderColor?: string;
+	/**
+	 * The taskbar icon. Falls back to icon if not provided.
+	 */
+	taskbarIcon?: string;
 }
diff --git a/how-to/workspace-platform-starter/public/schemas/settings.schema.json b/how-to/workspace-platform-starter/public/schemas/settings.schema.json
@@ -4180,6 +4180,10 @@
                     "description": "This defaults to manifest.platform.icon if not provided.",
                     "type": "string"
                 },
+                "taskbarIcon": {
+                    "description": "The taskbar icon. Falls back to icon if not provided.",
+                    "type": "string"
+                },
                 "textColor": {
                     "description": "The text color, defaults to theme text.",
                     "type": "string"

diff --git a/how-to/workspace-platform-starter/public/schemas/wps.manifest.schema.json b/how-to/workspace-platform-starter/public/schemas/wps.manifest.schema.json
@@ -4172,6 +4172,10 @@
 					"description": "This defaults to manifest.platform.icon if not provided.",
 					"type": "string"
 				},
+				"taskbarIcon": {
+					"description": "The taskbar icon. Falls back to icon if not provided.",
+					"type": "string"
+				},
 				"textColor": {
 					"description": "The text color, defaults to theme text.",
 					"type": "string"