From 01c12e63a7088a41598e382bc925de75c7d63ca4 Mon Sep 17 00:00:00 2001 From: Oliver Kucharzewski Date: Tue, 19 Aug 2025 14:07:15 +1000 Subject: [PATCH 1/3] feat: add syntax warning for loadWidget usage and provide usage example --- src/widget-loader.ts | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/src/widget-loader.ts b/src/widget-loader.ts index 2f49bce..614bf63 100644 --- a/src/widget-loader.ts +++ b/src/widget-loader.ts @@ -130,7 +130,42 @@ function addConfigFilter(sdk: ISdk, settings: EnforcedWidgetSettings) { } } +function showSyntaxWarning() { + alert( + "Please ensure you are using loadWidget(sdk, settings), and declare const sdk: ISdk at the top of your file, please check console for correct syntax" + ) + + console.info(` + import { loadWidget, loadAllUnloadedTiles, ISdk } from "@stackla/widget-utils" + declare const sdk: ISdk + + loadWidget(sdk, { + callbacks: { + onHover: [ + event => { + const tile = event.detail.tile + tile.style.transition = "opacity 0.5s" + tile.style.opacity = "0.5" + } + ], + onMouseLeave: [ + event => { + const tile = event.detail.tile + tile.style.transition = "opacity 0.5s" + tile.style.opacity = "1" + } + ] + } + })) + `) +} + export function loadWidget(sdk: ISdk, settings?: MyWidgetSettings) { + if (!sdk?.querySelectorAll) { + showSyntaxWarning() + return + } + const settingsWithDefaults = mergeSettingsWithDefaults(settings) sdk.storeWidgetTemplateSettings(settingsWithDefaults) From 2ce46750c462c0cbdfa4f274149530fb08b35860 Mon Sep 17 00:00:00 2001 From: Oliver Kucharzewski Date: Tue, 19 Aug 2025 14:09:57 +1000 Subject: [PATCH 2/3] feat: update syntax warning for loadWidget usage and provide correct usage example --- src/widget-loader.ts | 52 ++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/src/widget-loader.ts b/src/widget-loader.ts index 614bf63..f3a379b 100644 --- a/src/widget-loader.ts +++ b/src/widget-loader.ts @@ -131,32 +131,32 @@ function addConfigFilter(sdk: ISdk, settings: EnforcedWidgetSettings) { } function showSyntaxWarning() { - alert( - "Please ensure you are using loadWidget(sdk, settings), and declare const sdk: ISdk at the top of your file, please check console for correct syntax" - ) - - console.info(` - import { loadWidget, loadAllUnloadedTiles, ISdk } from "@stackla/widget-utils" - declare const sdk: ISdk - - loadWidget(sdk, { - callbacks: { - onHover: [ - event => { - const tile = event.detail.tile - tile.style.transition = "opacity 0.5s" - tile.style.opacity = "0.5" - } - ], - onMouseLeave: [ - event => { - const tile = event.detail.tile - tile.style.transition = "opacity 0.5s" - tile.style.opacity = "1" - } - ] - } - })) + alert("This method of using loadWidget is deprecated. Please check console for details.") + + console.warn(` + CORRECT USAGE: + + import { loadWidget, loadAllUnloadedTiles, ISdk } from "@stackla/widget-utils" + declare const sdk: ISdk + + loadWidget(sdk, { + callbacks: { + onHover: [ + event => { + const tile = event.detail.tile + tile.style.transition = "opacity 0.5s" + tile.style.opacity = "0.5" + } + ], + onMouseLeave: [ + event => { + const tile = event.detail.tile + tile.style.transition = "opacity 0.5s" + tile.style.opacity = "1" + } + ] + } + })) `) } From d24c70d735e6bd11882b8db3864024cfb195d60f Mon Sep 17 00:00:00 2001 From: Oliver Kucharzewski Date: Tue, 19 Aug 2025 14:10:28 +1000 Subject: [PATCH 3/3] fix: update usage example in showSyntaxWarning for loadWidget --- src/widget-loader.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/widget-loader.ts b/src/widget-loader.ts index f3a379b..8e48d3f 100644 --- a/src/widget-loader.ts +++ b/src/widget-loader.ts @@ -136,7 +136,7 @@ function showSyntaxWarning() { console.warn(` CORRECT USAGE: - import { loadWidget, loadAllUnloadedTiles, ISdk } from "@stackla/widget-utils" + import { loadWidget, ISdk } from "@stackla/widget-utils" declare const sdk: ISdk loadWidget(sdk, {