From 6295c6a48745ead305b546c630e0bb31d0109c00 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Thu, 4 Jul 2024 00:03:58 +0000 Subject: [PATCH] upgrade deps && docs --- docs/functions/client_core_core.Core.html | 2 +- .../client_core_no_fouc.noFOUCScript.html | 2 +- .../client_switch_switch.Switch.html | 2 +- docs/functions/hooks_use_mode.useMode.html | 2 +- docs/functions/utils.useStore.html | 2 +- .../client_core_core.CoreProps.html | 8 +++--- .../client_switch_switch.SwitchProps.html | 8 +++--- .../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 +- pnpm-lock.yaml | 26 +++++++++---------- 23 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/functions/client_core_core.Core.html b/docs/functions/client_core_core.Core.html index cef068b4..3fd041cb 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 c2c98513..d094777e 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 dab76a44..cfacb3df 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 5ac6d454..d68cdf57 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 2e982b54..08b7c9ab 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 4aa1aa4b..3b12e334 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 9c3bf44d..c747fafb 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 490e27ed..3a063ef8 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 a1e05591..92fc94ef 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 a9b4fc70..8f4b8f49 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 6ba955e0..5a76a512 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 1bdb56d0..4f524e80 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 c02e760b..3518b779 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 ae9aee79..82c6a89d 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 bae04dcb..805ede51 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 68a33f85..f0c39a33 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 6d217963..4304e16b 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 0abcb703..c2b83f07 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 7f05ddcd..3b6412c9 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 9a0f2927..e8dc3e9b 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 8c62c576..758b578a 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 251c5de5..b80582cc 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 diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6b6dddc9..310c2057 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2879,8 +2879,8 @@ packages: resolution: {integrity: sha512-X7rqawQBvfdjS10YU1y1YVreA3SsLrW9dX2CewP2EbBJM4ypVNLDkO5y04gejPwKIY9lR+7r9gn3rFPt/kmWFg==} engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0} - inquirer@9.3.2: - resolution: {integrity: sha512-+ynEbhWKhyomnaX0n2aLIMSkgSlGB5RrWbNXnEqj6mdaIydu6y40MdBjL38SAB0JcdmOaIaMua1azdjLEr3sdw==} + inquirer@9.3.3: + resolution: {integrity: sha512-Z7lAi4XUBYRa6NPB0k+0+3dyhnyp2sAqVeiyogHyue93DvE9dPxp7oi7Gg8/KfWXSrGEsyBvZbl4PdBpS7ZKkg==} engines: {node: '>=18'} internal-slot@1.0.7: @@ -5307,8 +5307,8 @@ packages: resolution: {integrity: sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==} engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} - ws@8.17.1: - resolution: {integrity: sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==} + ws@8.18.0: + resolution: {integrity: sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==} engines: {node: '>=10.0.0'} peerDependencies: bufferutil: ^4.0.1 @@ -5365,8 +5365,8 @@ packages: resolution: {integrity: sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==} engines: {node: '>=12.20'} - yoctocolors-cjs@2.1.1: - resolution: {integrity: sha512-c6T13b6qYcJZvck7QbEFXrFX/Mu2KOjvAGiKHmYMUg96jxNpfP6i+psGW72BOPxOIDUJrORG+Kyu7quMX9CQBQ==} + yoctocolors-cjs@2.1.2: + resolution: {integrity: sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==} engines: {node: '>=18'} zwitch@2.0.4: @@ -8334,7 +8334,7 @@ snapshots: ini@4.1.3: {} - inquirer@9.3.2: + inquirer@9.3.3: dependencies: '@inquirer/figures': 1.0.3 ansi-escapes: 4.3.2 @@ -8347,7 +8347,7 @@ snapshots: string-width: 4.2.3 strip-ansi: 6.0.1 wrap-ansi: 6.2.0 - yoctocolors-cjs: 2.1.1 + yoctocolors-cjs: 2.1.2 internal-slot@1.0.7: dependencies: @@ -8981,7 +8981,7 @@ snapshots: whatwg-encoding: 2.0.0 whatwg-mimetype: 3.0.0 whatwg-url: 11.0.0 - ws: 8.17.1 + ws: 8.18.0 xml-name-validator: 4.0.0 transitivePeerDependencies: - bufferutil @@ -9009,7 +9009,7 @@ snapshots: whatwg-encoding: 3.1.1 whatwg-mimetype: 4.0.0 whatwg-url: 14.0.0 - ws: 8.17.1 + ws: 8.18.0 xml-name-validator: 5.0.0 transitivePeerDependencies: - bufferutil @@ -9636,7 +9636,7 @@ snapshots: del: 7.1.0 globby: 13.2.2 handlebars: 4.7.8 - inquirer: 9.3.2 + inquirer: 9.3.3 isbinaryfile: 5.0.2 lodash.get: 4.4.2 lower-case: 2.0.2 @@ -11321,7 +11321,7 @@ snapshots: imurmurhash: 0.1.4 signal-exit: 3.0.7 - ws@8.17.1: {} + ws@8.18.0: {} xml-name-validator@4.0.0: {} @@ -11356,6 +11356,6 @@ snapshots: yocto-queue@1.1.1: {} - yoctocolors-cjs@2.1.1: {} + yoctocolors-cjs@2.1.2: {} zwitch@2.0.4: {}