From a79b8d057449e1c1dcc48a1956bbf095e72c315c Mon Sep 17 00:00:00 2001 From: Cameron Date: Wed, 24 Jan 2024 12:01:06 +0000 Subject: [PATCH] feat(splash screen) add `taskbarIcon` property for splash screen window (#673) --- how-to/workspace-platform-starter/CHANGELOG.md | 1 + .../client/src/framework/platform/platform-splash.ts | 1 + .../client/src/framework/shapes/splash-shapes.ts | 5 +++++ .../client/types/module/shapes/splash-shapes.d.ts | 4 ++++ .../public/schemas/settings.schema.json | 4 ++++ .../public/schemas/wps.manifest.schema.json | 4 ++++ 6 files changed, 19 insertions(+) diff --git a/how-to/workspace-platform-starter/CHANGELOG.md b/how-to/workspace-platform-starter/CHANGELOG.md index 63dac74f63..d7d374f383 100644 --- 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 index 672eb67d44..f3a9a1ef1d 100644 --- 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 { 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 index 0a9642b2e0..ddc50567c2 100644 --- 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 index f650da851f..19650378d9 100644 --- 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 index d63b5b4eaf..1cf726dae5 100644 --- 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 index e8e2013cec..6e46211bf6 100644 --- 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"