Skip to content

add ThemeInit component that place script inside <head> tag #176

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 5 commits into from
Jan 4, 2024
Merged

add ThemeInit component that place script inside <head> tag #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ced1b6d
add ThemeInit component that place script inside <head> tag
dimfeld Jan 4, 2024
30d8b29
Fix bug
dimfeld Jan 4, 2024
4538b27
proper sorting
dimfeld Jan 4, 2024
61554e7
instantiate ThemeInit inside Settings component
dimfeld Jan 4, 2024
e07535e
add comment about stringified function
dimfeld Jan 4, 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
5 changes: 5 additions & 0 deletions .changeset/friendly-pets-reflect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"svelte-ux": patch
---

Add ThemeInit component to prevent flash of unstyled content when SSR is enabled
6 changes: 6 additions & 0 deletions packages/svelte-ux/src/lib/components/Settings.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
<script lang="ts">
import ThemeInit from './ThemeInit.svelte';
import { settings as setSettings, type Settings } from './settings';

export let settings: Settings;
/** Include the ThemeInit component to improve SSR compatibility. */
export let themeInit = true;

setSettings(settings);
</script>

{#if themeInit}
<ThemeInit />
{/if}
<slot />
12 changes: 12 additions & 0 deletions packages/svelte-ux/src/lib/components/ThemeInit.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<script>
import { createHeadSnippet } from '../styles/theme';
import { getSettings } from './settings';

const darkThemes = getSettings().themes?.dark ?? [];

let headSnippet = createHeadSnippet(darkThemes);
</script>

<svelte:head>
{@html headSnippet}
</svelte:head>
1 change: 1 addition & 0 deletions packages/svelte-ux/src/lib/components/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ export { default as Tab } from './Tab.svelte';
export { default as Tabs } from './Tabs.svelte';
export { default as TextField } from './TextField.svelte';
export { default as ThemeButton } from './ThemeButton.svelte';
export { default as ThemeInit } from './ThemeInit.svelte';
export { default as Tilt } from './Tilt.svelte';
export { default as Toggle } from './Toggle.svelte';
export { default as ToggleButton } from './ToggleButton.svelte';
Expand Down
24 changes: 24 additions & 0 deletions packages/svelte-ux/src/lib/styles/theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,27 @@ export const colorNames = [
'surface-300',
'surface-content',
];

/** Return a script tag that will set the initial theme from localStorage. This allows setting
* the theme before anything starts rendering, even when SSR is in use.
*
* This feels a bit weird compared to just placing the function directly in svelte:head,
* but it's the only way to inject the `darkThemes` array into the function.
**/
export function createHeadSnippet(darkThemes: string[]) {
function _applyInitialStyle(darkThemes) {
let theme = localStorage.getItem('theme');
if (theme) {
document.documentElement.dataset.theme = theme;
if (darkThemes.includes(theme)) {
document.documentElement.classList.add('dark');
}
} else if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
document.documentElement.classList.add('dark');
}
}

let darkThemeList = darkThemes.map((theme) => `'${theme}'`).join(', ');

return `<script>(${_applyInitialStyle.toString()})([${darkThemeList}])</script>`;
}