From 46e114e19b62023bb5335938def89ba062e06f50 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Wed, 7 Aug 2024 08:18:01 +0000 Subject: [PATCH] upgrade deps && docs --- ...client_color_switch_color_switch.ColorSwitch.html | 2 +- ...r_scheme_force_color_scheme.ForceColorScheme.html | 2 +- .../client_force_theme_force_theme.ForceTheme.html | 2 +- .../client_theme_switcher_no_fouc.noFOUCScript.html | 2 +- ..._theme_switcher_theme_switcher.ThemeSwitcher.html | 2 +- docs/functions/hooks_use_theme.useTheme.html | 2 +- ...js_ssg_theme_switcher.NextJsSSGThemeSwitcher.html | 2 +- ...js_ssg_theme_switcher.NextJsSSRThemeSwitcher.html | 2 +- ..._nextjs_ssg_theme_switcher.ServerSideWrapper.html | 2 +- ...target_remix_server_target.RemixServerTarget.html | 2 +- docs/functions/store.useForcedStore.html | 2 +- docs/functions/store.useThemeStore.html | 2 +- ...t_color_switch_color_switch.ColorSwitchProps.html | 6 +++--- ...e_switcher_theme_switcher.ThemeSwitcherProps.html | 8 ++++---- .../hooks_use_theme._internal_.UseThemeYield.html | 6 +++--- ...g_theme_switcher.NextJsSSRThemeSwitcherProps.html | 10 +++++----- ...js_ssg_theme_switcher.ServerSideWrapperProps.html | 10 +++++----- ...et_remix_server_target._internal_.ForcedPage.html | 4 ++-- ...ver_target._internal_.RemixServerTargetProps.html | 10 +++++----- docs/interfaces/store.ForcedStoreType.html | 6 +++--- docs/interfaces/store.ThemeStoreType.html | 12 ++++++------ docs/modules/client_color_switch_color_switch.html | 2 +- ...client_force_color_scheme_force_color_scheme.html | 2 +- docs/modules/client_force_theme_force_theme.html | 2 +- docs/modules/client_theme_switcher_no_fouc.html | 2 +- .../client_theme_switcher_theme_switcher.html | 2 +- docs/modules/constants.html | 2 +- docs/modules/hooks_use_theme.html | 2 +- ...ssg_theme_switcher_nextjs_ssg_theme_switcher.html | 2 +- ...emix_remix_server_target_remix_server_target.html | 2 +- docs/modules/store.html | 2 +- docs/modules/types.html | 2 +- .../client_theme_switcher_no_fouc.ResolveFunc.html | 2 +- .../client_theme_switcher_no_fouc.UpdateDOMFunc.html | 2 +- ...theme_switcher_no_fouc.UpdateForcedPropsFunc.html | 2 +- ...theme_switcher_no_fouc._internal_.ValuesType.html | 2 +- ...witcher_nextjs_ssg_theme_switcher.ForcedPage.html | 2 +- docs/types/types.ColorSchemeType.html | 2 +- docs/types/types.ResolvedColorSchemeType.html | 2 +- docs/variables/constants.DARK.html | 2 +- docs/variables/constants.DEFAULT_ID.html | 2 +- docs/variables/constants.LIGHT.html | 2 +- docs/variables/constants.SYSTEM.html | 2 +- docs/variables/store.initialState.html | 2 +- pnpm-lock.yaml | 12 ++++++------ 45 files changed, 77 insertions(+), 77 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index 7a4c6e36..b0a6efa3 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -6,4 +6,4 @@ 
<ColorSwitch size={20} skipSystem />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html index 33917672..6bcad9e9 100644 --- a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html +++ b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html @@ -1,2 +1,2 @@ ForceColorScheme | React18 Themes

Function ForceColorScheme

Force color scheme on a page

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_force_theme_force_theme.ForceTheme.html b/docs/functions/client_force_theme_force_theme.ForceTheme.html index ad9a0e27..4856dcd3 100644 --- a/docs/functions/client_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/client_force_theme_force_theme.ForceTheme.html @@ -1,2 +1,2 @@ ForceTheme | React18 Themes

Function ForceTheme

Force theme on a page

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_theme_switcher_no_fouc.noFOUCScript.html b/docs/functions/client_theme_switcher_no_fouc.noFOUCScript.html index d380ea13..14e1d2b2 100644 --- a/docs/functions/client_theme_switcher_no_fouc.noFOUCScript.html +++ b/docs/functions/client_theme_switcher_no_fouc.noFOUCScript.html @@ -1,2 +1,2 @@ noFOUCScript | React18 Themes

Function noFOUCScript

Script to be injected for avoiding FOUC

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html index c8cc02ab..a5e71d8a 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -7,4 +7,4 @@

Sourceconst ThemeSwitcher = ({
forcedTheme,
forcedColorScheme,
targetSelector,
themeTransition,
styles,
nonce,
}: ThemeSwitcherProps) => {
const k = targetSelector || `#${DEFAULT_ID}`;
// handle client side exceptions when script is not run. <- for client side apps like vite or CRA
if (typeof window !== "undefined" && !window.m)
noFOUCScript(k, initialState, styles, forcedTheme, forcedColorScheme);

const [state, setState] = useThemeStore(targetSelector);
const [forced] = useForcedStore(targetSelector);

useEffect(() => {
media.addEventListener("change", () =>
setState(state => ({ ...state, s: media.matches ? DARK : LIGHT })),
);
addEventListener("storage", e => {
if (e.key === k) setState(state => ({ ...state, ...JSON.parse(e.newValue || "{}") }));
});
}, []);

useEffect(() => {
const restoreThansitions = modifyTransition(themeTransition);
updateDOM(resolveTheme(state));
restoreThansitions();
localStorage.setItem(k, JSON.stringify(state));
}, [state]);

useEffect(() => {
updateForcedProps(forcedTheme, forcedColorScheme);
updateDOM(resolveTheme(state));
}, [forcedColorScheme, forcedTheme]);

useEffect(() => {
updateForcedState(forced.f, forced.fc);
updateDOM(resolveTheme(state));
}, [forced]);

return <Script {...{ k, n: nonce, s: styles, t: forcedTheme, c: forcedColorScheme }} />;
} -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/hooks_use_theme.useTheme.html b/docs/functions/hooks_use_theme.useTheme.html index a952b3c5..1798fd81 100644 --- a/docs/functions/hooks_use_theme.useTheme.html +++ b/docs/functions/hooks_use_theme.useTheme.html @@ -1,4 +1,4 @@ useTheme | React18 Themes

Function useTheme

Example

const [] = useTheme(options);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSGThemeSwitcher.html b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSGThemeSwitcher.html index 61bb779e..3732d139 100644 --- a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSGThemeSwitcher.html +++ b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSGThemeSwitcher.html @@ -5,4 +5,4 @@

Example

<NextJsSSGThemeSwitcher />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcher.html b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcher.html index a0ec0719..ba329d50 100644 --- a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcher.html +++ b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcher.html @@ -5,4 +5,4 @@

Example

<NextJsSSRThemeSwitcher />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapper.html b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapper.html index d57c3b54..efba04c9 100644 --- a/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapper.html +++ b/docs/functions/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapper.html @@ -6,4 +6,4 @@

Example

<ServerSideWrapperProps lang="en">
 <body>
   <ThemeSwitcher />
   {children}
 </body>
</ServerSideWrapperProps>
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/server_remix_remix_server_target_remix_server_target.RemixServerTarget.html b/docs/functions/server_remix_remix_server_target_remix_server_target.RemixServerTarget.html index a7c0dbf8..338a8aa7 100644 --- a/docs/functions/server_remix_remix_server_target_remix_server_target.RemixServerTarget.html +++ b/docs/functions/server_remix_remix_server_target_remix_server_target.RemixServerTarget.html @@ -4,4 +4,4 @@

Example

<RemixServerTarget />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/store.useForcedStore.html b/docs/functions/store.useForcedStore.html index e5dbbdd8..67cf4df3 100644 --- a/docs/functions/store.useForcedStore.html +++ b/docs/functions/store.useForcedStore.html @@ -1 +1 @@ -useForcedStore | React18 Themes

Function useForcedStore

Settings

Member Visibility
+useForcedStore | React18 Themes

Function useForcedStore

Settings

Member Visibility
diff --git a/docs/functions/store.useThemeStore.html b/docs/functions/store.useThemeStore.html index 7aa0e781..7f6e7539 100644 --- a/docs/functions/store.useThemeStore.html +++ b/docs/functions/store.useThemeStore.html @@ -1,2 +1,2 @@ useThemeStore | React18 Themes

Function useThemeStore

internal store

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html index d91d1209..7d5d4141 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,6 +1,6 @@ -ColorSwitchProps | React18 Themes

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetSelector?: string;
}

Hierarchy

Properties

size? +ColorSwitchProps | React18 Themes

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetSelector?: string;
}

Hierarchy

Properties

size? skipSystem? targetSelector?

Properties

Optionalsize

size?: number

Diameter of the color switch

-

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

OptionaltargetSelector

targetSelector?: string

Settings

Member Visibility

On This Page

Properties
+

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

OptionaltargetSelector

targetSelector?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html index 3c38f0f4..4da639f8 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,9 +1,9 @@ -ThemeSwitcherProps | React18 Themes

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    nonce?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? +ThemeSwitcherProps | React18 Themes

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    nonce?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? forcedTheme? nonce? styles? targetSelector? themeTransition? -

Properties

OptionalforcedColorScheme

forcedColorScheme?: ColorSchemeType

OptionalforcedTheme

forcedTheme?: string

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

-

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

OptionaltargetSelector

targetSelector?: string

OptionalthemeTransition

themeTransition?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalforcedColorScheme

forcedColorScheme?: ColorSchemeType

OptionalforcedTheme

forcedTheme?: string

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

+

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

OptionaltargetSelector

targetSelector?: string

OptionalthemeTransition

themeTransition?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/hooks_use_theme._internal_.UseThemeYield.html b/docs/interfaces/hooks_use_theme._internal_.UseThemeYield.html index 279967c5..3d46a7b8 100644 --- a/docs/interfaces/hooks_use_theme._internal_.UseThemeYield.html +++ b/docs/interfaces/hooks_use_theme._internal_.UseThemeYield.html @@ -1,4 +1,4 @@ -UseThemeYield | React18 Themes

Interface UseThemeYield

interface UseThemeYield {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    lightTheme: string;
    resolvedColorScheme: ResolvedColorSchemeType;
    resolvedTheme: string;
    setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void);
    setDarkTheme: ((darkTheme: string) => void);
    setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void);
    setForcedTheme: ((forcedTheme: string) => void);
    setLightTheme: ((lightTheme: string) => void);
    setTheme: ((theme: string) => void);
    setThemeSet: ((themeSet: {
        darkTheme: string;
        lightTheme: string;
    }) => void);
    systemColorScheme: ResolvedColorSchemeType;
    theme: string;
    toggleColorScheme: ((skipSystem?: boolean) => void);
}

Properties

colorSchemePref +UseThemeYield | React18 Themes

Interface UseThemeYield

interface UseThemeYield {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    lightTheme: string;
    resolvedColorScheme: ResolvedColorSchemeType;
    resolvedTheme: string;
    setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void);
    setDarkTheme: ((darkTheme: string) => void);
    setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void);
    setForcedTheme: ((forcedTheme: string) => void);
    setLightTheme: ((lightTheme: string) => void);
    setTheme: ((theme: string) => void);
    setThemeSet: ((themeSet: {
        darkTheme: string;
        lightTheme: string;
    }) => void);
    systemColorScheme: ResolvedColorSchemeType;
    theme: string;
    toggleColorScheme: ((skipSystem?: boolean) => void);
}

Properties

colorSchemePref darkTheme lightTheme resolvedColorScheme @@ -13,5 +13,5 @@ systemColorScheme theme toggleColorScheme -

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

lightTheme

lightTheme: string

resolvedColorScheme

resolvedColorScheme: ResolvedColorSchemeType

resolvedTheme

resolvedTheme: string

setColorSchemePref

setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void)

setDarkTheme

setDarkTheme: ((darkTheme: string) => void)

setForcedColorScheme

setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void)

setForcedTheme

setForcedTheme: ((forcedTheme: string) => void)

setLightTheme

setLightTheme: ((lightTheme: string) => void)

setTheme

setTheme: ((theme: string) => void)

actions

-

setThemeSet

setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)

systemColorScheme

systemColorScheme: ResolvedColorSchemeType

theme

theme: string

toggleColorScheme

toggleColorScheme: ((skipSystem?: boolean) => void)

Settings

Member Visibility

On This Page

Properties
+

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

lightTheme

lightTheme: string

resolvedColorScheme

resolvedColorScheme: ResolvedColorSchemeType

resolvedTheme

resolvedTheme: string

setColorSchemePref

setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void)

setDarkTheme

setDarkTheme: ((darkTheme: string) => void)

setForcedColorScheme

setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void)

setForcedTheme

setForcedTheme: ((forcedTheme: string) => void)

setLightTheme

setLightTheme: ((lightTheme: string) => void)

setTheme

setTheme: ((theme: string) => void)

actions

+

setThemeSet

setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)

systemColorScheme

systemColorScheme: ResolvedColorSchemeType

theme

theme: string

toggleColorScheme

toggleColorScheme: ((skipSystem?: boolean) => void)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcherProps.html b/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcherProps.html index 34e4d105..517483bc 100644 --- a/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcherProps.html +++ b/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.NextJsSSRThemeSwitcherProps.html @@ -1,11 +1,11 @@ -NextJsSSRThemeSwitcherProps | React18 Themes

Interface NextJsSSRThemeSwitcherProps

Deprecated

interface NextJsSSRThemeSwitcherProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Hierarchy (view full)

Properties

children? +NextJsSSRThemeSwitcherProps | React18 Themes

Interface NextJsSSRThemeSwitcherProps

Deprecated

interface NextJsSSRThemeSwitcherProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Hierarchy (view full)

Properties

children? forcedPages? styles? tag? targetId? -

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
+

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
-

OptionaltargetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Settings

Member Visibility

On This Page

Properties
+

OptionaltargetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapperProps.html b/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapperProps.html index ab23c0df..6da6537f 100644 --- a/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapperProps.html +++ b/docs/interfaces/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ServerSideWrapperProps.html @@ -1,11 +1,11 @@ -ServerSideWrapperProps | React18 Themes

Interface ServerSideWrapperProps

Deprecated

interface ServerSideWrapperProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Hierarchy (view full)

Properties

children? +ServerSideWrapperProps | React18 Themes

Interface ServerSideWrapperProps

Deprecated

interface ServerSideWrapperProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Hierarchy (view full)

Properties

children? forcedPages? styles? tag? targetId? -

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'html'
+

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'html'
-

OptionaltargetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Settings

Member Visibility

On This Page

Properties
+

OptionaltargetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.ForcedPage.html b/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.ForcedPage.html index d67cc124..9e007bd6 100644 --- a/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.ForcedPage.html +++ b/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.ForcedPage.html @@ -1,3 +1,3 @@ -ForcedPage | React18 Themes

Interface ForcedPage

Deprecated

interface ForcedPage {
    pathMatcher: string | RegExp;
    themes: {
        colorScheme?: ColorSchemeType;
        theme?: string;
    };
}

Properties

pathMatcher +ForcedPage | React18 Themes

Interface ForcedPage

Deprecated

interface ForcedPage {
    pathMatcher: string | RegExp;
    themes: {
        colorScheme?: ColorSchemeType;
        theme?: string;
    };
}

Properties

pathMatcher themes -

Properties

pathMatcher

pathMatcher: string | RegExp

themes

themes: {
    colorScheme?: ColorSchemeType;
    theme?: string;
}

Settings

Member Visibility

On This Page

Properties
+

Properties

pathMatcher

pathMatcher: string | RegExp

themes

themes: {
    colorScheme?: ColorSchemeType;
    theme?: string;
}

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.RemixServerTargetProps.html b/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.RemixServerTargetProps.html index 88a6cefb..f4270916 100644 --- a/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.RemixServerTargetProps.html +++ b/docs/interfaces/server_remix_remix_server_target_remix_server_target._internal_.RemixServerTargetProps.html @@ -1,10 +1,10 @@ -RemixServerTargetProps | React18 Themes

Interface RemixServerTargetProps

Deprecated

interface RemixServerTargetProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
}

Hierarchy

Properties

children? +RemixServerTargetProps | React18 Themes

Interface RemixServerTargetProps

Deprecated

interface RemixServerTargetProps {
    children?: ReactNode;
    forcedPages?: ForcedPage[];
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
}

Hierarchy

Properties

children? forcedPages? styles? tag? -

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

not implemented yet

-

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

-

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
+

Properties

Optionalchildren

children?: ReactNode

OptionalforcedPages

forcedPages?: ForcedPage[]

not implemented yet

+

Optionalstyles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, if you are using CSS/SCSS modules.

+

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/store.ForcedStoreType.html b/docs/interfaces/store.ForcedStoreType.html index 7770cd98..03d8395e 100644 --- a/docs/interfaces/store.ForcedStoreType.html +++ b/docs/interfaces/store.ForcedStoreType.html @@ -1,5 +1,5 @@ -ForcedStoreType | React18 Themes

Interface ForcedStoreType

interface ForcedStoreType {
    f?: string;
    fc?: ColorSchemeType;
}

Properties

f? +ForcedStoreType | React18 Themes

Interface ForcedStoreType

interface ForcedStoreType {
    f?: string;
    fc?: ColorSchemeType;
}

Properties

f? fc?

Properties

Optionalf

f?: string

forced theme

-

Optionalfc

fc?: ColorSchemeType

forced colorScheme

-

Settings

Member Visibility

On This Page

Properties
+

Optionalfc

fc?: ColorSchemeType

forced colorScheme

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/store.ThemeStoreType.html b/docs/interfaces/store.ThemeStoreType.html index 86e5284f..726c7fcd 100644 --- a/docs/interfaces/store.ThemeStoreType.html +++ b/docs/interfaces/store.ThemeStoreType.html @@ -1,11 +1,11 @@ -ThemeStoreType | React18 Themes

Interface ThemeStoreType

interface ThemeStoreType {
    c: ColorSchemeType;
    d: string;
    l: string;
    s: ResolvedColorSchemeType;
    t: string;
}

Properties

c +ThemeStoreType | React18 Themes

Interface ThemeStoreType

interface ThemeStoreType {
    c: ColorSchemeType;
    d: string;
    l: string;
    s: ResolvedColorSchemeType;
    t: string;
}

Properties

c d l s t

Properties

c

c: ColorSchemeType

colorSchemePref

-

d

d: string

darkTheme

-

l

l: string

lightTheme

-

s

s: ResolvedColorSchemeType

systemColorScheme

-

t

t: string

theme

-

Settings

Member Visibility

On This Page

Properties
+

d

d: string

darkTheme

+

l

l: string

lightTheme

+

s

s: ResolvedColorSchemeType

systemColorScheme

+

t

t: string

theme

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/modules/client_color_switch_color_switch.html b/docs/modules/client_color_switch_color_switch.html index a5a78c3a..4fd732a8 100644 --- a/docs/modules/client_color_switch_color_switch.html +++ b/docs/modules/client_color_switch_color_switch.html @@ -1,3 +1,3 @@ -client/color-switch/color-switch | React18 Themes

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps +client/color-switch/color-switch | React18 Themes

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps

Functions

ColorSwitch

Settings

Member Visibility
diff --git a/docs/modules/client_force_color_scheme_force_color_scheme.html b/docs/modules/client_force_color_scheme_force_color_scheme.html index 6aba59a9..12faa72a 100644 --- a/docs/modules/client_force_color_scheme_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme/force-color-scheme | React18 Themes

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme +client/force-color-scheme/force-color-scheme | React18 Themes

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme

Settings

Member Visibility
diff --git a/docs/modules/client_force_theme_force_theme.html b/docs/modules/client_force_theme_force_theme.html index 4508ae55..0eba548b 100644 --- a/docs/modules/client_force_theme_force_theme.html +++ b/docs/modules/client_force_theme_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme/force-theme | React18 Themes

Module client/force-theme/force-theme

Index

Functions

ForceTheme +client/force-theme/force-theme | React18 Themes

Module client/force-theme/force-theme

Index

Functions

ForceTheme

Settings

Member Visibility
diff --git a/docs/modules/client_theme_switcher_no_fouc.html b/docs/modules/client_theme_switcher_no_fouc.html index 68141602..fea8ce01 100644 --- a/docs/modules/client_theme_switcher_no_fouc.html +++ b/docs/modules/client_theme_switcher_no_fouc.html @@ -1,4 +1,4 @@ -client/theme-switcher/no-fouc | React18 Themes

Module client/theme-switcher/no-fouc

Index

Modules

<internal> +client/theme-switcher/no-fouc | React18 Themes

Module client/theme-switcher/no-fouc

Index

Modules

<internal>

Type Aliases

ResolveFunc UpdateDOMFunc UpdateForcedPropsFunc diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index 111cdac1..d28aa569 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,3 +1,3 @@ -client/theme-switcher/theme-switcher | React18 Themes

Module client/theme-switcher/theme-switcher

Index

Interfaces

ThemeSwitcherProps +client/theme-switcher/theme-switcher | React18 Themes

Module client/theme-switcher/theme-switcher

Index

Interfaces

ThemeSwitcherProps

Functions

ThemeSwitcher

Settings

Member Visibility
diff --git a/docs/modules/constants.html b/docs/modules/constants.html index a42a7349..5a519275 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | React18 Themes

Module constants

Index

Variables

DARK +constants | React18 Themes

Module constants

Index

Variables

DARK DEFAULT_ID LIGHT SYSTEM diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 80d79165..f2a1860e 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,3 +1,3 @@ -hooks/use-theme | React18 Themes

Module hooks/use-theme

Index

Modules

<internal> +hooks/use-theme | React18 Themes

Module hooks/use-theme

Index

Modules

<internal>

Functions

useTheme

Settings

Member Visibility
diff --git a/docs/modules/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.html b/docs/modules/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.html index 15c5b905..c7c8031a 100644 --- a/docs/modules/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.html +++ b/docs/modules/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.html @@ -1,4 +1,4 @@ -server/nextjs/nextjs-ssg-theme-switcher/nextjs-ssg-theme-switcher | React18 Themes

Module server/nextjs/nextjs-ssg-theme-switcher/nextjs-ssg-theme-switcher

References

NextJsServerTarget +server/nextjs/nextjs-ssg-theme-switcher/nextjs-ssg-theme-switcher | React18 Themes

Module server/nextjs/nextjs-ssg-theme-switcher/nextjs-ssg-theme-switcher

References

NextJsServerTarget

Interfaces

NextJsSSRThemeSwitcherProps ServerSideWrapperProps

Type Aliases

ForcedPage diff --git a/docs/modules/server_remix_remix_server_target_remix_server_target.html b/docs/modules/server_remix_remix_server_target_remix_server_target.html index 965f5040..8fd70e18 100644 --- a/docs/modules/server_remix_remix_server_target_remix_server_target.html +++ b/docs/modules/server_remix_remix_server_target_remix_server_target.html @@ -1,3 +1,3 @@ -server/remix/remix-server-target/remix-server-target | React18 Themes

Module server/remix/remix-server-target/remix-server-target

Index

Modules

<internal> +server/remix/remix-server-target/remix-server-target | React18 Themes

Module server/remix/remix-server-target/remix-server-target

Index

Modules

<internal>

Functions

RemixServerTarget

Settings

Member Visibility
diff --git a/docs/modules/store.html b/docs/modules/store.html index 39434652..9781478b 100644 --- a/docs/modules/store.html +++ b/docs/modules/store.html @@ -1,4 +1,4 @@ -store | React18 Themes

Module store

Index

Interfaces

ForcedStoreType +store | React18 Themes

Module store

Index

Interfaces

ForcedStoreType ThemeStoreType

Variables

initialState

Functions

useForcedStore diff --git a/docs/modules/types.html b/docs/modules/types.html index 213690b4..a7d3dfe8 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1,3 +1,3 @@ -types | React18 Themes

Module types

Index

Type Aliases

ColorSchemeType +types | React18 Themes

Module types

Index

Type Aliases

ColorSchemeType ResolvedColorSchemeType

Settings

Member Visibility
diff --git a/docs/types/client_theme_switcher_no_fouc.ResolveFunc.html b/docs/types/client_theme_switcher_no_fouc.ResolveFunc.html index 27a5fc90..46baaaca 100644 --- a/docs/types/client_theme_switcher_no_fouc.ResolveFunc.html +++ b/docs/types/client_theme_switcher_no_fouc.ResolveFunc.html @@ -1 +1 @@ -ResolveFunc | React18 Themes

Type Alias ResolveFunc

ResolveFunc: ((store: ThemeStoreType) => ValuesType)

Settings

Member Visibility
+ResolveFunc | React18 Themes

Type Alias ResolveFunc

ResolveFunc: ((store: ThemeStoreType) => ValuesType)

Settings

Member Visibility
diff --git a/docs/types/client_theme_switcher_no_fouc.UpdateDOMFunc.html b/docs/types/client_theme_switcher_no_fouc.UpdateDOMFunc.html index 26606b89..3632e6e9 100644 --- a/docs/types/client_theme_switcher_no_fouc.UpdateDOMFunc.html +++ b/docs/types/client_theme_switcher_no_fouc.UpdateDOMFunc.html @@ -1 +1 @@ -UpdateDOMFunc | React18 Themes

Type Alias UpdateDOMFunc

UpdateDOMFunc: ((values: ValuesType) => void)

Settings

Member Visibility
+UpdateDOMFunc | React18 Themes

Type Alias UpdateDOMFunc

UpdateDOMFunc: ((values: ValuesType) => void)

Settings

Member Visibility
diff --git a/docs/types/client_theme_switcher_no_fouc.UpdateForcedPropsFunc.html b/docs/types/client_theme_switcher_no_fouc.UpdateForcedPropsFunc.html index 9f9f5138..75ffd432 100644 --- a/docs/types/client_theme_switcher_no_fouc.UpdateForcedPropsFunc.html +++ b/docs/types/client_theme_switcher_no_fouc.UpdateForcedPropsFunc.html @@ -1 +1 @@ -UpdateForcedPropsFunc | React18 Themes

Type Alias UpdateForcedPropsFunc

UpdateForcedPropsFunc: ((forcedThemeProp?: string, forcedColorSchemeProp?: ColorSchemeType) => void)

Settings

Member Visibility
+UpdateForcedPropsFunc | React18 Themes

Type Alias UpdateForcedPropsFunc

UpdateForcedPropsFunc: ((forcedThemeProp?: string, forcedColorSchemeProp?: ColorSchemeType) => void)

Settings

Member Visibility
diff --git a/docs/types/client_theme_switcher_no_fouc._internal_.ValuesType.html b/docs/types/client_theme_switcher_no_fouc._internal_.ValuesType.html index f3c79ad5..8ca08cc0 100644 --- a/docs/types/client_theme_switcher_no_fouc._internal_.ValuesType.html +++ b/docs/types/client_theme_switcher_no_fouc._internal_.ValuesType.html @@ -1 +1 @@ -ValuesType | React18 Themes

Type Alias ValuesType

ValuesType: [ResolvedColorSchemeType, ColorSchemeType, string, string]

Settings

Member Visibility
+ValuesType | React18 Themes

Type Alias ValuesType

ValuesType: [ResolvedColorSchemeType, ColorSchemeType, string, string]

Settings

Member Visibility
diff --git a/docs/types/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ForcedPage.html b/docs/types/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ForcedPage.html index b5361a8f..8ce509a6 100644 --- a/docs/types/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ForcedPage.html +++ b/docs/types/server_nextjs_nextjs_ssg_theme_switcher_nextjs_ssg_theme_switcher.ForcedPage.html @@ -1 +1 @@ -ForcedPage | React18 Themes

Type Alias ForcedPage

ForcedPage: {
    pathMatcher: RegExp | string;
    props: ThemeSwitcherProps;
}

Deprecated

Settings

Member Visibility
+ForcedPage | React18 Themes

Type Alias ForcedPage

ForcedPage: {
    pathMatcher: RegExp | string;
    props: ThemeSwitcherProps;
}

Deprecated

Settings

Member Visibility
diff --git a/docs/types/types.ColorSchemeType.html b/docs/types/types.ColorSchemeType.html index 523b8efd..9f7c0046 100644 --- a/docs/types/types.ColorSchemeType.html +++ b/docs/types/types.ColorSchemeType.html @@ -1,2 +1,2 @@ ColorSchemeType | React18 Themes

Type Alias ColorSchemeType

ColorSchemeType:
    | ""
    | "system"
    | "dark"
    | "light"

Types to be exposed to users

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/types.ResolvedColorSchemeType.html b/docs/types/types.ResolvedColorSchemeType.html index 6e0111aa..428a01b3 100644 --- a/docs/types/types.ResolvedColorSchemeType.html +++ b/docs/types/types.ResolvedColorSchemeType.html @@ -1 +1 @@ -ResolvedColorSchemeType | React18 Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"

Settings

Member Visibility
+ResolvedColorSchemeType | React18 Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"

Settings

Member Visibility
diff --git a/docs/variables/constants.DARK.html b/docs/variables/constants.DARK.html index 68657278..dabc17f6 100644 --- a/docs/variables/constants.DARK.html +++ b/docs/variables/constants.DARK.html @@ -1 +1 @@ -DARK | React18 Themes

Variable DARKConst

DARK: "dark" = "dark"

Settings

Member Visibility
+DARK | React18 Themes

Variable DARKConst

DARK: "dark" = "dark"

Settings

Member Visibility
diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index b31f3671..3f1fbcc8 100644 --- a/docs/variables/constants.DEFAULT_ID.html +++ b/docs/variables/constants.DEFAULT_ID.html @@ -1,2 +1,2 @@ DEFAULT_ID | React18 Themes

Variable DEFAULT_IDConst

DEFAULT_ID: "rth" = "rth"

shared constants -- keep in separate files for better tree-shaking and dependency injection

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/constants.LIGHT.html b/docs/variables/constants.LIGHT.html index 4bb542c3..c34cef82 100644 --- a/docs/variables/constants.LIGHT.html +++ b/docs/variables/constants.LIGHT.html @@ -1 +1 @@ -LIGHT | React18 Themes

Variable LIGHTConst

LIGHT: "light" = "light"

Settings

Member Visibility
+LIGHT | React18 Themes

Variable LIGHTConst

LIGHT: "light" = "light"

Settings

Member Visibility
diff --git a/docs/variables/constants.SYSTEM.html b/docs/variables/constants.SYSTEM.html index 804d64b9..24af3334 100644 --- a/docs/variables/constants.SYSTEM.html +++ b/docs/variables/constants.SYSTEM.html @@ -1 +1 @@ -SYSTEM | React18 Themes

Variable SYSTEMConst

SYSTEM: "system" = "system"

Settings

Member Visibility
+SYSTEM | React18 Themes

Variable SYSTEMConst

SYSTEM: "system" = "system"

Settings

Member Visibility
diff --git a/docs/variables/store.initialState.html b/docs/variables/store.initialState.html index 30b0a939..0b7d59d5 100644 --- a/docs/variables/store.initialState.html +++ b/docs/variables/store.initialState.html @@ -1 +1 @@ -initialState | React18 Themes

Variable initialStateConst

initialState: ThemeStoreType = ...

Settings

Member Visibility
+initialState | React18 Themes

Variable initialStateConst

initialState: ThemeStoreType = ...

Settings

Member Visibility
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8df8c09a..59f9a89b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1763,8 +1763,8 @@ packages: resolution: {integrity: sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==} engines: {node: '>=16'} - caniuse-lite@1.0.30001649: - resolution: {integrity: sha512-fJegqZZ0ZX8HOWr6rcafGr72+xcgJKI9oWfDW5DrD7ExUtgZC7a7R7ZYmZqplh7XDocFdGeIFn7roAxhOeYrPQ==} + caniuse-lite@1.0.30001650: + resolution: {integrity: sha512-fgEc7hP/LB7iicdXHUI9VsBsMZmUmlVJeQP2qqQW+3lkqVhbmjEU8zp+h5stWeilX+G7uXuIUIIlWlDw9jdt8g==} capital-case@1.0.4: resolution: {integrity: sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==} @@ -6752,7 +6752,7 @@ snapshots: autoprefixer@10.4.20(postcss@8.4.41): dependencies: browserslist: 4.23.3 - caniuse-lite: 1.0.30001649 + caniuse-lite: 1.0.30001650 fraction.js: 4.3.7 normalize-range: 0.1.2 picocolors: 1.0.1 @@ -6859,7 +6859,7 @@ snapshots: browserslist@4.23.3: dependencies: - caniuse-lite: 1.0.30001649 + caniuse-lite: 1.0.30001650 electron-to-chromium: 1.5.5 node-releases: 2.0.18 update-browserslist-db: 1.1.0(browserslist@4.23.3) @@ -6912,7 +6912,7 @@ snapshots: camelcase@8.0.0: {} - caniuse-lite@1.0.30001649: {} + caniuse-lite@1.0.30001650: {} capital-case@1.0.4: dependencies: @@ -9460,7 +9460,7 @@ snapshots: '@next/env': 14.2.5 '@swc/helpers': 0.5.5 busboy: 1.6.0 - caniuse-lite: 1.0.30001649 + caniuse-lite: 1.0.30001650 graceful-fs: 4.2.11 postcss: 8.4.31 react: 18.3.1