Skip to content

feat: add disableTransition option and set default to true #192

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
merged 10 commits into from
Mar 21, 2024
Merged

feat: add disableTransition option and set default to true #192

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1372d68
feat: add `disableTransition`
zcf0508 May 10, 2023
dec1e3f
fix: Refactor boolean value parsing
zcf0508 May 11, 2023
2ee89d6
lint: fix lint error
zcf0508 May 11, 2023
0e99645
Merge branch 'master' into pr/zcf0508/192
antfu Jun 21, 2023
31c44f7
Merge remote-tracking branch 'nuxt-modules/master'
zcf0508 Aug 13, 2023
795e3cd
refactor: `disableTransition ` set default to `false`
zcf0508 Aug 14, 2023
0267174
Merge branch 'nuxt-modules:master' into master
zcf0508 Nov 16, 2023
a0ae9fc
refactor
zcf0508 Nov 16, 2023
3fccf39
Merge remote-tracking branch 'upstream/main'
zcf0508 Mar 20, 2024
8e8f171
perf: refactor to enable tree-shaking transition code
danielroe Mar 21, 2024
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
10 changes: 9 additions & 1 deletion src/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ const DEFAULTS: ModuleOptions = {
classPrefix: '',
classSuffix: '-mode',
dataValue: '',
storageKey: 'nuxt-color-mode'
storageKey: 'nuxt-color-mode',
disableTransition: true
}

export default defineNuxtModule({
Expand Down Expand Up @@ -162,4 +163,11 @@ export interface ModuleOptions {
* The script that will be injected into the head of the page
*/
script?: string
/**
* Disable transition on switch
*
* @see https://paco.me/writing/disable-theme-transitions
* @default true
*/
disableTransition?: boolean
}
13 changes: 13 additions & 0 deletions src/runtime/plugin.client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { globalName, storageKey, dataValue } from '#color-mode-options'
const helper = window[globalName] as unknown as {
preference: string
value: string
disableTransition: string
getColorScheme: () => string
addColorScheme: (className: string) => void
removeColorScheme: (className: string) => void
Expand Down Expand Up @@ -87,8 +88,20 @@ export default defineNuxtPlugin((nuxtApp) => {
}, { immediate: true })

watch(() => colorMode.value, (newValue, oldValue) => {
let style: HTMLStyleElement | undefined
if (helper.disableTransition === 'true') {
style = window!.document.createElement('style')
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)
if (helper.disableTransition === 'true') {
// Calling getComputedStyle forces the browser to redraw
// @ts-expect-error unused variable
const _ = window!.getComputedStyle(style!).opacity
document.head.removeChild(style!)
}
})

if (colorMode.preference === 'system') {
Expand Down
1 change: 1 addition & 0 deletions src/script.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ addColorScheme(value)
w['<%= options.globalName %>'] = {
preference,
value,
disableTransition: '<%= options.disableTransition %>',
getColorScheme,
addColorScheme,
removeColorScheme
Expand Down