Skip to content

fix: Improve global window augmentation for tooltips with proper types #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adammatthiesen merged 4 commits into from
Jan 6, 2026
Merged

fix: Improve global window augmentation for tooltips with proper types #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ffb470
fix: Improve global window augmentation for tooltips with better type…
Adammatthiesen Jan 6, 2026
e0b3b69
fix: Improve error handling in tooltip options parsing and update VSC…
Adammatthiesen Jan 6, 2026
6056e43
fix: Update comments for global augmentations in events.d.ts
Adammatthiesen Jan 6, 2026
51daf4e
Update .changeset/few-eyes-provide.md
Adammatthiesen Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/few-eyes-provide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@studiocms/ui": patch
---

Fixes global window augmentation for tooltips (no user-facing changes, just better types!)
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,8 @@
"material-icon-theme.files.associations": {
"*.e2e.ts": "playwright",
"*.test.ts": "vitest"
},
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome"
}
}
4 changes: 0 additions & 4 deletions packages/studiocms_ui/src/components/Tooltip/tooltip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,6 @@ function loadTooltips() {
const anchor = tooltipInstance.getAnchor();
const popup = tooltipInstance.tooltip;

// @ts-expect-error
window.sui.tooltips.instances.set(tooltipInstance.container.id, tooltipInstance);

anchor.addEventListener('mouseenter', () => {
Expand Down Expand Up @@ -394,11 +393,8 @@ function loadTooltips() {
});
}

// TODO: Investigate why global type definitions are not being recognized
// @ts-expect-error
window.sui = window.sui ?? {};

// @ts-expect-error
window.sui.tooltips = {
instances: new Map<string, Tooltip>(),

Expand Down
26 changes: 14 additions & 12 deletions packages/studiocms_ui/src/events.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/** biome-ignore-all lint/correctness/noUnusedVariables: Global augments */

/**
* CustomEventMap defines the custom events used in the application.
*
Expand Down Expand Up @@ -39,6 +41,18 @@ interface SuiTooltipApi {
hide: (id: string) => void;
}

interface Window {
/**
* The StudioCMS UI API, which includes various tools and utilities for the UI.
*/
sui: {
/**
* The tooltip API, which provides methods for managing tooltips in the UI.
*/
tooltips: SuiTooltipApi;
};
}

/**
* Extends the global `Document` interface to include custom event handling methods.
*
Expand Down Expand Up @@ -89,16 +103,4 @@ declare global {
*/
dispatchEvent<K extends keyof CustomEventMap>(ev: CustomEventMap[K]): void;
}

interface Window {
/**
* The StudioCMS UI API, which includes various tools and utilities for the UI.
*/
sui: {
/**
* The tooltip API, which provides methods for managing tooltips in the UI.
*/
tooltips: SuiTooltipApi;
};
}
}
Loading