An open source design system that's fully customizable and agent ready
TypeScript
fix: stabilize useTheme return values (#5274)
nynexman446489abbb3edc14
diff --git a/.changeset/stable-use-theme.md b/.changeset/stable-use-theme.mdnew file mode 100644index 0000000000..c24c356630--- /dev/null+++ b/.changeset/stable-use-theme.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[fix] Keep useTheme token resolvers and return values stable when the resolved theme is unchanged.++@nynexman4464diff --git a/packages/core/src/theme/useTheme.test.tsx b/packages/core/src/theme/useTheme.test.tsxindex c6e8abb539..ba7de97769 100644--- a/packages/core/src/theme/useTheme.test.tsx+++ b/packages/core/src/theme/useTheme.test.tsx@@ -108,6 +108,16 @@ describe('useTheme', () => {expect(result.current.token('--color-text-primary')).toBe('#DFE2E5');});+ it('keeps the token resolver and return object stable across rerenders', () => {+ const {result, rerender} = renderHook(() => useTheme());+ const first = result.current;++ rerender();++ expect(result.current.token).toBe(first.token);+ expect(result.current).toBe(first);+ });+it('returns empty string for unknown tokens', () => {const {result} = renderHook(() => useTheme(), {wrapper: ({children}) => wrapper({children, mode: 'light'}),diff --git a/packages/core/src/theme/useTheme.ts b/packages/core/src/theme/useTheme.tsindex d1a7bfb2bf..c841a3c570 100644--- a/packages/core/src/theme/useTheme.ts+++ b/packages/core/src/theme/useTheme.ts@@ -21,7 +21,13 @@* - /packages/core/src/theme/index.ts*/-import {createContext, use, useMemo, useSyncExternalStore} from 'react';+import {+ createContext,+ use,+ useCallback,+ useMemo,+ useSyncExternalStore,+} from 'react';import type {ThemeMode} from './types';import type {DefinedTheme} from './defineTheme';import {resolveThemeTokens} from './tokens';@@ -281,14 +287,14 @@ export function useTheme(): UseThemeReturn {[theme, effectiveMode],);- const token = (name: string): string => {- return tokens[name] ?? '';- };+ const token = useCallback(+ (name: string): string => tokens[name] ?? '',+ [tokens],+ );+ const name = theme?.name ?? 'default';- return {- name: theme?.name ?? 'default',- mode: effectiveMode,- token,- tokens,- };+ return useMemo(+ () => ({name, mode: effectiveMode, token, tokens}),+ [name, effectiveMode, token, tokens],+ );}