From 32edf5b8854d429ad8e50a6004f09770128c0c16 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Sat, 29 Jun 2024 16:02:13 +0000 Subject: [PATCH] upgrade deps && docs --- docs/functions/client_core_core.Core.html | 2 +- docs/functions/client_core_no_fouc.noFOUCScript.html | 2 +- docs/functions/client_switch_switch.Switch.html | 2 +- docs/functions/hooks_use_mode.useMode.html | 2 +- docs/functions/utils.useStore.html | 2 +- docs/interfaces/client_core_core.CoreProps.html | 8 ++++---- docs/interfaces/client_switch_switch.SwitchProps.html | 8 ++++---- docs/interfaces/hooks_use_mode.UseModeYeild.html | 4 ++-- docs/interfaces/utils.Store.html | 4 ++-- docs/modules/client_core_core.html | 2 +- docs/modules/client_core_no_fouc.html | 2 +- docs/modules/client_switch_switch.html | 2 +- docs/modules/constants.html | 2 +- docs/modules/hooks_use_mode.html | 2 +- docs/modules/hooks_use_mode_test.html | 2 +- docs/modules/utils.html | 2 +- docs/types/utils.ColorSchemePreference.html | 2 +- docs/types/utils.ResolvedScheme.html | 2 +- docs/variables/constants.DARK.html | 2 +- docs/variables/constants.LIGHT.html | 2 +- docs/variables/constants.SYSTEM.html | 2 +- docs/variables/constants.modes.html | 2 +- 22 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/functions/client_core_core.Core.html b/docs/functions/client_core_core.Core.html index 8e2bd1dc..14c0b8a5 100644 --- a/docs/functions/client_core_core.Core.html +++ b/docs/functions/client_core_core.Core.html @@ -9,4 +9,4 @@

Sourceconst Core = ({ t, nonce, k = "o" }: CoreProps) => {
// 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);

const [{ m: mode, s: systemMode }, setThemeState] = useStore();

useEffect(() => {
// store global functions to local variables to avoid any interference
[media, updateDOM] = [m, u];

media.addEventListener("change", () =>
setThemeState(state => ({ ...state, s: media.matches ? DARK : LIGHT })),
);
/** Sync the tabs */
addEventListener("storage", (e: StorageEvent): void => {
e.key === k && setThemeState(state => ({ ...state, m: e.newValue as ColorSchemePreference }));
});
}, []);

useEffect(() => {
const restoreTransitions = modifyTransition(t, nonce);
updateDOM(mode, systemMode);
restoreTransitions();
}, [systemMode, mode, t, nonce]);

return <Script {...{ n: nonce, k }} />;
} -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/client_core_no_fouc.noFOUCScript.html b/docs/functions/client_core_no_fouc.noFOUCScript.html index bec209cb..68a4a285 100644 --- a/docs/functions/client_core_no_fouc.noFOUCScript.html +++ b/docs/functions/client_core_no_fouc.noFOUCScript.html @@ -1,2 +1,2 @@ noFOUCScript | React18 Loaders

Function noFOUCScript

function to be injected in script tag for avoiding FOUC

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/client_switch_switch.Switch.html b/docs/functions/client_switch_switch.Switch.html index 919362db..b9e5b1d5 100644 --- a/docs/functions/client_switch_switch.Switch.html +++ b/docs/functions/client_switch_switch.Switch.html @@ -8,4 +8,4 @@

Sourceconst Switch = ({
tag: Tag = "button",
size = 24,
skipSystem,
children,
...props
}: SwitchProps) => {
const [state, setState] = useStore();

const handleModeSwitch = () => {
let index = modes.indexOf(state.m);
const n = modes.length;
if (skipSystem && index === n - 1) index = 0;
setState({
...state,
m: modes[(index + 1) % n],
});
};
if (children) {
return (
// @ts-expect-error -- too complex types
<Tag
suppressHydrationWarning
{...props}
data-testid="switch"
// skipcq: JS-0417
onClick={handleModeSwitch}>
{/* @ts-expect-error -> we are setting the CSS variable */}
<div className={styles.switch} style={{ "--size": `${size}px` }} />
{children}
</Tag>
);
}
return (
<Tag
// Hydration warning is caused when the data from localStorage differs from the default data provided while rendering on server
suppressHydrationWarning
{...props}
className={[props.className, styles.switch].join(" ")}
// @ts-expect-error -> we are setting the CSS variable
style={{ "--size": `${size}px` }}
data-testid="switch"
// skipcq: JS-0417 -> tradeoff between size and best practices
onClick={handleModeSwitch}
/>
);
} -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/hooks_use_mode.useMode.html b/docs/functions/hooks_use_mode.useMode.html index 3f1debc2..227247c6 100644 --- a/docs/functions/hooks_use_mode.useMode.html +++ b/docs/functions/hooks_use_mode.useMode.html @@ -8,4 +8,4 @@

Sourceconst useMode = (): UseModeYeild => {
const [{ m: mode, s: systemMode }, setState] = useStore();

const setMode = (m: ColorSchemePreference) => {
setState(prev => ({ ...prev, m }));
};
return {
mode,
systemMode,
resolvedMode: (mode === SYSTEM ? systemMode : mode) as ResolvedScheme,
setMode,
};
} -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.useStore.html b/docs/functions/utils.useStore.html index 15c582a7..e3d9eedc 100644 --- a/docs/functions/utils.useStore.html +++ b/docs/functions/utils.useStore.html @@ -1,2 +1,2 @@ useStore | React18 Loaders

Function useStore

local abstaction of RGS to avoid multiple imports

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/client_core_core.CoreProps.html b/docs/interfaces/client_core_core.CoreProps.html index abe64c5e..34c62b7f 100644 --- a/docs/interfaces/client_core_core.CoreProps.html +++ b/docs/interfaces/client_core_core.CoreProps.html @@ -1,16 +1,16 @@ -CoreProps | React18 Loaders

Interface CoreProps

interface CoreProps {
    k?: string;
    nonce?: string;
    t?: string;
}

Properties

k? +CoreProps | React18 Loaders

Interface CoreProps

interface CoreProps {
    k?: string;
    nonce?: string;
    t?: string;
}

Properties

k? nonce? t?

Properties

Optionalk

k?: string

storageKey

Default Value

'o'
-

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

+

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

Default Value

''
-

Optionalt

t?: string

themeTransition: force apply CSS transition property to all the elements during theme switching. E.g., all .3s

+

Optionalt

t?: string

themeTransition: force apply CSS transition property to all the elements during theme switching. E.g., all .3s

Default Value

'none'
-

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file +

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/interfaces/client_switch_switch.SwitchProps.html b/docs/interfaces/client_switch_switch.SwitchProps.html index 0463f8d8..8afbe654 100644 --- a/docs/interfaces/client_switch_switch.SwitchProps.html +++ b/docs/interfaces/client_switch_switch.SwitchProps.html @@ -1,10 +1,10 @@ -SwitchProps | React18 Loaders

Interface SwitchProps

interface SwitchProps {
    size?: number;
    skipSystem?: boolean;
    tag?: "button" | "div";
}

Hierarchy

Properties

size? +SwitchProps | React18 Loaders

Interface SwitchProps

interface SwitchProps {
    size?: number;
    skipSystem?: boolean;
    tag?: "button" | "div";
}

Hierarchy

Properties

size? skipSystem? tag?

Properties

Optionalsize

size?: number

Diameter of the color switch

-

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

Optionaltag

tag?: "button" | "div"

html tag

+

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

Optionaltag

tag?: "button" | "div"

html tag

Default Value

'button'
-

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file +

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/interfaces/hooks_use_mode.UseModeYeild.html b/docs/interfaces/hooks_use_mode.UseModeYeild.html index 27d372c4..78ecb05f 100644 --- a/docs/interfaces/hooks_use_mode.UseModeYeild.html +++ b/docs/interfaces/hooks_use_mode.UseModeYeild.html @@ -1,5 +1,5 @@ -UseModeYeild | React18 Loaders

Interface UseModeYeild

interface UseModeYeild {
    mode: ColorSchemePreference;
    resolvedMode: ResolvedScheme;
    setMode: ((mode: ColorSchemePreference) => void);
    systemMode: ResolvedScheme;
}

Properties

mode +UseModeYeild | React18 Loaders

Interface UseModeYeild

interface UseModeYeild {
    mode: ColorSchemePreference;
    resolvedMode: ResolvedScheme;
    setMode: ((mode: ColorSchemePreference) => void);
    systemMode: ResolvedScheme;
}

Properties

mode resolvedMode setMode systemMode -

Properties

mode

mode: ColorSchemePreference

resolvedMode

resolvedMode: ResolvedScheme

setMode

setMode: ((mode: ColorSchemePreference) => void)

systemMode

systemMode: ResolvedScheme

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file +

Properties

mode

mode: ColorSchemePreference

resolvedMode

resolvedMode: ResolvedScheme

setMode

setMode: ((mode: ColorSchemePreference) => void)

systemMode

systemMode: ResolvedScheme

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/interfaces/utils.Store.html b/docs/interfaces/utils.Store.html index 9371de83..4305a5d1 100644 --- a/docs/interfaces/utils.Store.html +++ b/docs/interfaces/utils.Store.html @@ -1,3 +1,3 @@ -Store | React18 Loaders

Interface Store

interface Store {
    m: ColorSchemePreference;
    s: ResolvedScheme;
}

Properties

m +Store | React18 Loaders

Interface Store

interface Store {
    m: ColorSchemePreference;
    s: ResolvedScheme;
}

Properties

m s -

Properties

m

m: ColorSchemePreference

s

s: ResolvedScheme

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file +

Properties

m

m: ColorSchemePreference

s

s: ResolvedScheme

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file diff --git a/docs/modules/client_core_core.html b/docs/modules/client_core_core.html index 7781873f..b860cc3c 100644 --- a/docs/modules/client_core_core.html +++ b/docs/modules/client_core_core.html @@ -1,3 +1,3 @@ -client/core/core | React18 Loaders

Module client/core/core

Index

Interfaces

CoreProps +client/core/core | React18 Loaders

Module client/core/core

Index

Interfaces

CoreProps

Functions

Core

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/client_core_no_fouc.html b/docs/modules/client_core_no_fouc.html index 7c6cd2f4..6a05532d 100644 --- a/docs/modules/client_core_no_fouc.html +++ b/docs/modules/client_core_no_fouc.html @@ -1,2 +1,2 @@ -client/core/no-fouc | React18 Loaders

Module client/core/no-fouc

Index

Functions

noFOUCScript +client/core/no-fouc | React18 Loaders

Module client/core/no-fouc

Index

Functions

noFOUCScript

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/client_switch_switch.html b/docs/modules/client_switch_switch.html index 73b3b0ce..e0fcc2a8 100644 --- a/docs/modules/client_switch_switch.html +++ b/docs/modules/client_switch_switch.html @@ -1,3 +1,3 @@ -client/switch/switch | React18 Loaders

Module client/switch/switch

Index

Interfaces

SwitchProps +client/switch/switch | React18 Loaders

Module client/switch/switch

Index

Interfaces

SwitchProps

Functions

Switch

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/constants.html b/docs/modules/constants.html index eb540239..50d84df7 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | React18 Loaders

Module constants

Index

Variables

DARK +constants | React18 Loaders

Module constants

Index

Variables

DARK LIGHT SYSTEM modes diff --git a/docs/modules/hooks_use_mode.html b/docs/modules/hooks_use_mode.html index 8b7d07ae..9ad2ac98 100644 --- a/docs/modules/hooks_use_mode.html +++ b/docs/modules/hooks_use_mode.html @@ -1,3 +1,3 @@ -hooks/use-mode | React18 Loaders

Module hooks/use-mode

Index

Interfaces

UseModeYeild +hooks/use-mode | React18 Loaders

Module hooks/use-mode

Index

Interfaces

UseModeYeild

Functions

useMode

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/hooks_use_mode_test.html b/docs/modules/hooks_use_mode_test.html index fcb61110..ff99d3ca 100644 --- a/docs/modules/hooks_use_mode_test.html +++ b/docs/modules/hooks_use_mode_test.html @@ -1 +1 @@ -hooks/use-mode.test | React18 Loaders

Module hooks/use-mode.test

Settings

Member Visibility
\ No newline at end of file +hooks/use-mode.test | React18 Loaders

Module hooks/use-mode.test

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 64b7febd..51678cf3 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,4 +1,4 @@ -utils | React18 Loaders

Module utils

Index

Interfaces

Store +utils | React18 Loaders

Module utils

Index

Interfaces

Store

Type Aliases

ColorSchemePreference ResolvedScheme

Functions

useStore diff --git a/docs/types/utils.ColorSchemePreference.html b/docs/types/utils.ColorSchemePreference.html index 91a71484..16e3ae0d 100644 --- a/docs/types/utils.ColorSchemePreference.html +++ b/docs/types/utils.ColorSchemePreference.html @@ -1 +1 @@ -ColorSchemePreference | React18 Loaders

Type Alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | ""

Settings

Member Visibility
\ No newline at end of file +ColorSchemePreference | React18 Loaders

Type Alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | ""

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils.ResolvedScheme.html b/docs/types/utils.ResolvedScheme.html index be89db2d..3334d2a9 100644 --- a/docs/types/utils.ResolvedScheme.html +++ b/docs/types/utils.ResolvedScheme.html @@ -1 +1 @@ -ResolvedScheme | React18 Loaders

Type Alias ResolvedScheme

ResolvedScheme: "dark" | ""

Settings

Member Visibility
\ No newline at end of file +ResolvedScheme | React18 Loaders

Type Alias ResolvedScheme

ResolvedScheme: "dark" | ""

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/constants.DARK.html b/docs/variables/constants.DARK.html index 166ff195..c004e8cd 100644 --- a/docs/variables/constants.DARK.html +++ b/docs/variables/constants.DARK.html @@ -1 +1 @@ -DARK | React18 Loaders

Variable DARKConst

DARK: ResolvedScheme = "dark"

Settings

Member Visibility
\ No newline at end of file +DARK | React18 Loaders

Variable DARKConst

DARK: ResolvedScheme = "dark"

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/constants.LIGHT.html b/docs/variables/constants.LIGHT.html index d7720ae5..0c2a5688 100644 --- a/docs/variables/constants.LIGHT.html +++ b/docs/variables/constants.LIGHT.html @@ -1 +1 @@ -LIGHT | React18 Loaders

Variable LIGHTConst

LIGHT: ResolvedScheme = ""

Settings

Member Visibility
\ No newline at end of file +LIGHT | React18 Loaders

Variable LIGHTConst

LIGHT: ResolvedScheme = ""

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/constants.SYSTEM.html b/docs/variables/constants.SYSTEM.html index df8b610a..e21421af 100644 --- a/docs/variables/constants.SYSTEM.html +++ b/docs/variables/constants.SYSTEM.html @@ -1 +1 @@ -SYSTEM | React18 Loaders

Variable SYSTEMConst

SYSTEM: ColorSchemePreference = "system"

Settings

Member Visibility
\ No newline at end of file +SYSTEM | React18 Loaders

Variable SYSTEMConst

SYSTEM: ColorSchemePreference = "system"

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/constants.modes.html b/docs/variables/constants.modes.html index 3f7184a2..29b4fbbe 100644 --- a/docs/variables/constants.modes.html +++ b/docs/variables/constants.modes.html @@ -1 +1 @@ -modes | React18 Loaders

Variable modesConst

modes: ColorSchemePreference[] = ...

Settings

Member Visibility
\ No newline at end of file +modes | React18 Loaders

Variable modesConst

modes: ColorSchemePreference[] = ...

Settings

Member Visibility
\ No newline at end of file