Skip to content

fix: Stub helper utility with no-ops if it doesn't exist on the window object #325

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: Stub helper utility with no-ops if it doesn't exist on the window object #325

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6860fa7
create fallback helper for breaking vitest tests
Sep 26, 2025
5f54803
save
Sep 26, 2025
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
30 changes: 19 additions & 11 deletions src/runtime/plugin.client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,28 @@ import type { ColorModeInstance } from './types'
import { defineNuxtPlugin, isVue2, isVue3, useRouter, useHead, useState } from '#imports'
import { globalName, storageKey, dataValue, disableTransition, storage } from '#color-mode-options'

// Initialise to empty object to avoid hard error when hydrating app in test mode
const helper = (window[globalName] || {}) as unknown as {
type Helper = {
preference: string
value: string
getColorScheme: () => string
addColorScheme: (className: string) => void
removeColorScheme: (className: string) => void
}

// Initialise to object with defaults and no-ops to avoid hard error when hydrating app in test mode
const helper: Helper = (window[globalName] as unknown as Helper || {
preference: 'light',
value: 'light',
getColorScheme: () => 'light',
addColorScheme: () => {},
removeColorScheme: () => {},
})

export default defineNuxtPlugin((nuxtApp) => {
const colorMode = useState<ColorModeInstance>('color-mode', () => reactive({
// For SPA mode or fallback
preference: helper.preference,
value: helper.value,
preference: helper?.preference,
value: helper?.value,
unknown: false,
forced: false,
})).value
Expand Down Expand Up @@ -56,7 +64,7 @@ export default defineNuxtPlugin((nuxtApp) => {
}
colorMode.forced = false
colorMode.value = colorMode.preference === 'system'
? helper.getColorScheme()
? helper?.getColorScheme()
: colorMode.preference
}
})
Expand All @@ -71,7 +79,7 @@ export default defineNuxtPlugin((nuxtApp) => {
darkWatcher = window.matchMedia('(prefers-color-scheme: dark)')
darkWatcher.addEventListener('change', () => {
if (!colorMode.forced && colorMode.preference === 'system') {
colorMode.value = helper.getColorScheme()
colorMode.value = helper?.getColorScheme()
}
})
}
Expand All @@ -95,7 +103,7 @@ export default defineNuxtPlugin((nuxtApp) => {
return
}
if (preference === 'system') {
colorMode.value = helper.getColorScheme()
colorMode.value = helper?.getColorScheme()
watchMedia()
}
else {
Expand All @@ -114,8 +122,8 @@ export default defineNuxtPlugin((nuxtApp) => {
style.appendChild(document.createTextNode('*{-webkit-transition:none!important;-moz-transition:none!important;-o-transition:none!important;-ms-transition:none!important;transition:none!important}'))
window!.document.head.appendChild(style)
}
helper.removeColorScheme(oldValue)
helper.addColorScheme(newValue)
helper?.removeColorScheme(oldValue)
helper?.addColorScheme(newValue)
if (disableTransition) {
// Calling getComputedStyle forces the browser to redraw

Expand All @@ -130,8 +138,8 @@ export default defineNuxtPlugin((nuxtApp) => {

nuxtApp.hook('app:mounted', () => {
if (colorMode.unknown) {
colorMode.preference = helper.preference
colorMode.value = helper.value
colorMode.preference = helper?.preference
colorMode.value = helper?.value
colorMode.unknown = false
}
})
Expand Down
Loading