Skip to content
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.

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

feat(#750): add themestore and usetheme #881

Merged
merged 6 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
41 changes: 41 additions & 0 deletions next/src/hooks/useTheme.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { type Theme, THEMES } from "../types";
import { useEffect } from "react";
const PREFERRED_THEME = "dark"; // preferred theme must be dark for Tailwind
Copy link
Contributor

Choose a reason for hiding this comment

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

How come?


function isPreferredTheme(theme, matchObj?) {
if (typeof window === "undefined") {
return;
}

const preferredThemeMatches = (
matchObj || window?.matchMedia(`(prefers-color-scheme: ${PREFERRED_THEME})`)
).matches;

return theme === PREFERRED_THEME || (theme === "system" && preferredThemeMatches);
}

export function handleTheme(theme, matchObj?) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we use arrow syntax. Also, should we have type params for these functions

if (typeof document === "undefined") {
return;
}

const classList = document.documentElement.classList;

if (isPreferredTheme(theme, matchObj)) {
classList.add(PREFERRED_THEME);
} else {
classList.remove(PREFERRED_THEME);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Whats going on here, worth some comments?

}

export function useTheme(theme: Theme) {
theme = THEMES.includes(theme) ? theme : "system";

useEffect(() => {
const preferredTheme = window.matchMedia(`(prefers-color-scheme: ${PREFERRED_THEME})`);
Copy link
Contributor

Choose a reason for hiding this comment

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

What's going on here? What if their preferred theme isn't dark?


preferredTheme.addEventListener("change", (event) => {
handleTheme(theme, event);
});
}, []);
}
1 change: 1 addition & 0 deletions next/src/stores/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from "./messageStore";
export * from "./agentStore";
export * from "./modelSettingsStore";
export * from "./themeStore";
57 changes: 57 additions & 0 deletions next/src/stores/themeStore.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import type { StateCreator } from "zustand";
import { createSelectors } from "./helpers";
import { create } from "zustand";
import { createJSONStorage, persist } from "zustand/middleware";
import type { Theme } from "../types";
import { handleTheme } from "../hooks/useTheme";

const resetters: (() => void)[] = [];

interface ThemeSlice {
theme: Theme;
setTheme: (theme: Theme) => void;
}

const initialThemeState = {
theme: "system" as const,
};

const createThemeSlice: StateCreator<ThemeSlice> = (set) => {
resetters.push(() => set(initialThemeState));

return {
...initialThemeState,
setTheme: (theme: Theme) => {
set(() => ({
theme,
}));

handleTheme(theme);
},
};
};

export const useThemeStore = createSelectors(
create<ThemeSlice>()(
persist(
(...a) => ({
...createThemeSlice(...a),
}),
{
name: "theme",
storage: createJSONStorage(() => localStorage),
onRehydrateStorage: () => {
return (state, error) => {
if (error) {
console.error("an error happened during hydration. ", error);
} else {
handleTheme(state ? state.theme : "system");
}
};
Comment on lines +43 to +50
Copy link
Contributor

Choose a reason for hiding this comment

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

Neat, so this way even if we have local storage we won't run into rehydration issues with SSR? If so, could also use these in the other stores (Had to use a separate hook for them to ensure there were no issues)

},
}
)
)
);

export const resetAllThemeSlices = () => resetters.forEach((resetter) => resetter());
1 change: 1 addition & 0 deletions next/src/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from "./propTypes";
export * from "./modelSettings";
export * from "./userSettings";
2 changes: 2 additions & 0 deletions next/src/types/userSettings.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const THEMES = ["dark" as const, "light" as const, "system" as const];
export type Theme = "dark" | "light" | "system";