Skip to content

feat: generate script text at build time #354

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
dario-piotrowicz wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −6
Open

feat: generate script text at build time #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions next-themes/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
'use client'

import * as React from 'react'
import { script } from './script'
import type { Attribute, ThemeProviderProps, UseThemeProps } from './types'

// @ts-ignore
import scriptTemplate from './script.template.js';
const scriptText = scriptTemplate as string;

const colorSchemes = ['light', 'dark']
const MEDIA = '(prefers-color-scheme: dark)'
const isServer = typeof window === 'undefined'
Expand Down Expand Up @@ -213,7 +216,7 @@ const ThemeScript = React.memo(
{...scriptProps}
suppressHydrationWarning
nonce={typeof window === 'undefined' ? nonce : ''}
dangerouslySetInnerHTML={{ __html: `(${script.toString()})(${scriptArgs})` }}
dangerouslySetInnerHTML={{ __html: `(${scriptText})(${scriptArgs})` }}
/>
)
}
Expand Down
6 changes: 3 additions & 3 deletions next-themes/src/script.ts → next-themes/src/script.template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export const script = (
(
attribute,
storageKey,
defaultTheme,
Expand All @@ -11,7 +11,7 @@ export const script = (
const el = document.documentElement
const systemThemes = ['light', 'dark']

function updateDOM(theme: string) {
function updateDOM(theme) {

@dario-piotrowicz dario-piotrowicz Apr 22, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: if there is a concern about loosing typesafety here this solution can be improved by either using jsdoc type comments here or adding a custom esbuild loader to the tsup config,

const attributes = Array.isArray(attribute) ? attribute : [attribute]

attributes.forEach(attr => {
Expand All @@ -28,7 +28,7 @@ export const script = (
setColorScheme(theme)
}

function setColorScheme(theme: string) {
function setColorScheme(theme) {
if (enableColorScheme && systemThemes.includes(theme)) {
el.style.colorScheme = theme
}
Expand Down
5 changes: 4 additions & 1 deletion next-themes/tsup.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@ export default defineConfig({
external: ['react'],
format: ['esm', 'cjs'],
splitting: false,
bundle: true
bundle: true,
loader: {
'.template.js': 'text'
},
})