From 00ffee288db7afe3a210b9ae51097c14841dcf42 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Fri, 22 Nov 2024 16:14:52 +0000 Subject: [PATCH] upgrade deps && docs --- .../client_color_switch_color_switch.ColorSwitch.html | 2 +- ...nt_theme_switcher_theme_switcher.ThemeSwitcher.html | 2 +- docs/functions/constants.useRGSMinify.html | 2 +- docs/functions/hooks_use_theme.useTheme-1.html | 2 +- .../server_force_theme_force_theme.ForceTheme.html | 2 +- ...erver_server_target_server_target.ServerTarget.html | 2 +- ...witch_color_switch._internal_.ColorSwitchProps.html | 8 ++++---- ...eme_switcher_theme_switcher.ThemeSwitcherProps.html | 10 +++++----- docs/interfaces/constants.ThemeState.html | 8 ++++---- docs/interfaces/hooks_use_theme.UseTheme.html | 4 ++-- ...e_theme_force_theme._internal_.ForceThemeProps.html | 8 ++++---- ...get_server_target._internal_.ServerTargetProps.html | 8 ++++---- docs/modules/client_color_switch_color_switch.html | 2 +- docs/modules/client_theme_switcher_theme_switcher.html | 2 +- docs/modules/constants.html | 2 +- docs/modules/hooks_use_theme.html | 2 +- docs/modules/hooks_use_theme_test.html | 2 +- docs/modules/server_force_theme_force_theme.html | 2 +- docs/modules/server_server_target_server_target.html | 2 +- docs/types/constants.ColorSchemePreference.html | 2 +- docs/variables/constants.DEFAULT_ID.html | 2 +- 21 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index 5ffdb561..62169f02 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -13,4 +13,4 @@ 
export const ColorSwitch = ({ targetId, skipSystem, size, ...props }: ColorSwitchProps) => {
  const {
    setColorSchemePreference,
    resolvedColorScheme: rcs,
    colorSchemePreference: csp,
  } = useTheme(targetId);
  const toggleColorScheme = () => {
    switch (csp) {
      case "dark":
        setColorSchemePreference("light");
        break;
      case "light":
        setColorSchemePreference(skipSystem ? "dark" : "system");
        break;
      case "system":
      default:
        setColorSchemePreference("dark");
        break;
    }
  };
  return (
    <button
      className={["nthul--color-switch", rcs, csp === "system" ? "system" : ""].join(" ")}
      data-testid="color-switch"
      {...props}
      onClick={toggleColorScheme}
      // @ts-expect-error -- setting custom attribute
      style={{ "--size": `${size}px` }}
      type="button"
    />
  );
};
-

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 d4b8f4fa..b36a7e68 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -1,3 +1,3 @@ ThemeSwitcher | React18 Loaders

Function ThemeSwitcher

The core ThemeSwitcher component wich applies classes and transitions. Cookies are set only if corresponding ServerTarget is detected.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/constants.useRGSMinify.html b/docs/functions/constants.useRGSMinify.html index e79ae18d..09a48d56 100644 --- a/docs/functions/constants.useRGSMinify.html +++ b/docs/functions/constants.useRGSMinify.html @@ -1,2 +1,2 @@ useRGSMinify | React18 Loaders

Function useRGSMinify

To avoid multiple r18gs imports

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/hooks_use_theme.useTheme-1.html b/docs/functions/hooks_use_theme.useTheme-1.html index 5b183674..795dcbcb 100644 --- a/docs/functions/hooks_use_theme.useTheme-1.html +++ b/docs/functions/hooks_use_theme.useTheme-1.html @@ -1,4 +1,4 @@ useTheme | React18 Loaders

Function useTheme

use this hook to gain access to theme state and setters from your components.

  • useTheme(targetId?): UseTheme

  • Parameters

    • OptionaltargetId: string

      targetId corresponding to ThemeSwitcher and others tied to specific container.

    Returns UseTheme

    themeState and setter fucntions

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/server_force_theme_force_theme.ForceTheme.html b/docs/functions/server_force_theme_force_theme.ForceTheme.html index 6bc09bf8..87d502cc 100644 --- a/docs/functions/server_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/server_force_theme_force_theme.ForceTheme.html @@ -1 +1 @@ -ForceTheme | React18 Loaders

Function ForceTheme

ForceTheme

Settings

Member Visibility

On This Page

ForceTheme
+ForceTheme | React18 Loaders

Function ForceTheme

ForceTheme

Settings

Member Visibility

On This Page

ForceTheme
diff --git a/docs/functions/server_server_target_server_target.ServerTarget.html b/docs/functions/server_server_target_server_target.ServerTarget.html index 1a4f3cc5..553f1656 100644 --- a/docs/functions/server_server_target_server_target.ServerTarget.html +++ b/docs/functions/server_server_target_server_target.ServerTarget.html @@ -2,4 +2,4 @@

Example

<html>
  ...
  <body>
    <ServerTarget />
    ...
  </body>
</html>
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/interfaces/client_color_switch_color_switch._internal_.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch._internal_.ColorSwitchProps.html index 756af2aa..b52b3527 100644 --- a/docs/interfaces/client_color_switch_color_switch._internal_.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch._internal_.ColorSwitchProps.html @@ -1,7 +1,7 @@ -ColorSwitchProps | React18 Loaders

Interface ColorSwitchProps

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

Hierarchy

Properties

size? +ColorSwitchProps | React18 Loaders

Interface ColorSwitchProps

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

Hierarchy

Properties

size? skipSystem? targetId?

Properties

Optionalsize

size?: number

Diameter of the color switch

-

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

OptionaltargetId

targetId?: string

id of target element if you are applying theme only to specific container. Should be same as corresponding ThemeSwitcher, etc.

-

Settings

Member Visibility

On This Page

Properties
+

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

OptionaltargetId

targetId?: string

id of target element if you are applying theme only to specific container. Should be same as corresponding ThemeSwitcher, etc.

+

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 39d3bf43..ead8aea9 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 Loaders

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    dontSync?: boolean;
    styles?: Record<string, string>;
    targetId?: string;
    themeTransition?: string;
}

Properties

dontSync? +ThemeSwitcherProps | React18 Loaders

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    dontSync?: boolean;
    styles?: Record<string, string>;
    targetId?: string;
    themeTransition?: string;
}

Properties

dontSync? styles? targetId? themeTransition?

Properties

OptionaldontSync

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-

Optionalstyles

styles?: Record<string, string>

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

-

OptionaltargetId

targetId?: string

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

-

OptionalthemeTransition

themeTransition?: string

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

-

Settings

Member Visibility

On This Page

Properties
+

Optionalstyles

styles?: Record<string, string>

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

+

OptionaltargetId

targetId?: string

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

+

OptionalthemeTransition

themeTransition?: string

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

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/constants.ThemeState.html b/docs/interfaces/constants.ThemeState.html index dba6ed85..5fc6d8f5 100644 --- a/docs/interfaces/constants.ThemeState.html +++ b/docs/interfaces/constants.ThemeState.html @@ -1,7 +1,7 @@ -ThemeState | React18 Loaders

Interface ThemeState

interface ThemeState {
    c: ColorSchemePreference;
    s: "dark" | "light";
    t: string;
}

Properties

c +ThemeState | React18 Loaders

Interface ThemeState

interface ThemeState {
    c: ColorSchemePreference;
    s: "dark" | "light";
    t: string;
}

Properties

c s t

Properties

c

c: ColorSchemePreference

ColorSchemePreference

-

s

s: "dark" | "light"

SystemColorScheme

-

t

t: string

Theme

-

Settings

Member Visibility

On This Page

Properties
+

s

s: "dark" | "light"

SystemColorScheme

+

t

t: string

Theme

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/hooks_use_theme.UseTheme.html b/docs/interfaces/hooks_use_theme.UseTheme.html index 8f39013d..4629e681 100644 --- a/docs/interfaces/hooks_use_theme.UseTheme.html +++ b/docs/interfaces/hooks_use_theme.UseTheme.html @@ -1,7 +1,7 @@ -UseTheme | React18 Loaders

Interface UseTheme

interface UseTheme {
    colorSchemePreference: ColorSchemePreference;
    resolvedColorScheme: "dark" | "light";
    setColorSchemePreference: ((colorSchemePreference: ColorSchemePreference) => void);
    setTheme: ((theme: string) => void);
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference +UseTheme | React18 Loaders

Interface UseTheme

interface UseTheme {
    colorSchemePreference: ColorSchemePreference;
    resolvedColorScheme: "dark" | "light";
    setColorSchemePreference: ((colorSchemePreference: ColorSchemePreference) => void);
    setTheme: ((theme: string) => void);
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference resolvedColorScheme setColorSchemePreference setTheme systemColorScheme theme -

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference: ColorSchemePreference) => void)

setTheme

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

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

On This Page

Properties
+

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference: ColorSchemePreference) => void)

setTheme

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

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_force_theme_force_theme._internal_.ForceThemeProps.html b/docs/interfaces/server_force_theme_force_theme._internal_.ForceThemeProps.html index d4b6be6d..09a60747 100644 --- a/docs/interfaces/server_force_theme_force_theme._internal_.ForceThemeProps.html +++ b/docs/interfaces/server_force_theme_force_theme._internal_.ForceThemeProps.html @@ -1,10 +1,10 @@ -ForceThemeProps | React18 Loaders

Interface ForceThemeProps

interface ForceThemeProps {
    children?: ReactNode;
    colorScheme?: "dark" | "light";
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    theme?: string;
}

Hierarchy

Properties

children? +ForceThemeProps | React18 Loaders

Interface ForceThemeProps

interface ForceThemeProps {
    children?: ReactNode;
    colorScheme?: "dark" | "light";
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    theme?: string;
}

Hierarchy

Properties

children? colorScheme? styles? tag? theme? -

Properties

Optionalchildren

children?: ReactNode

OptionalcolorScheme

colorScheme?: "dark" | "light"

Optionalstyles

styles?: Record<string, string>

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

-

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
+

Properties

Optionalchildren

children?: ReactNode

OptionalcolorScheme

colorScheme?: "dark" | "light"

Optionalstyles

styles?: Record<string, string>

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

+

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
-

Optionaltheme

theme?: string

Settings

Member Visibility

On This Page

Properties
+

Optionaltheme

theme?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/server_server_target_server_target._internal_.ServerTargetProps.html b/docs/interfaces/server_server_target_server_target._internal_.ServerTargetProps.html index 5a3e4cbc..ee8790f0 100644 --- a/docs/interfaces/server_server_target_server_target._internal_.ServerTargetProps.html +++ b/docs/interfaces/server_server_target_server_target._internal_.ServerTargetProps.html @@ -1,13 +1,13 @@ -ServerTargetProps | React18 Loaders

Interface ServerTargetProps

interface ServerTargetProps {
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Properties

styles? +ServerTargetProps | React18 Loaders

Interface ServerTargetProps

interface ServerTargetProps {
    styles?: Record<string, string>;
    tag?: keyof IntrinsicElements;
    targetId?: string;
}

Properties

styles? tag? targetId?

Properties

Optionalstyles

styles?: Record<string, string>

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

-

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
+

Optionaltag

tag?: keyof IntrinsicElements

Default Value

'div'
-

OptionaltargetId

targetId?: string

id of target element if you are applying theme only to specific container. +

OptionaltargetId

targetId?: string

id of target element if you are applying theme only to specific container. make sure you pass same targetId to corresponding ThemeSwitcher, ColorSwitch and useTheme hook as well.

Default Value

undefined
-

Settings

Member Visibility

On This Page

Properties
+

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 2bdbe513..6f2a654c 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 Loaders

Module client/color-switch/color-switch

Index

Modules

<internal> +client/color-switch/color-switch | React18 Loaders

Module client/color-switch/color-switch

Index

Modules

<internal>

Functions

ColorSwitch

Settings

Member Visibility
diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index 721b5fbe..fc333f76 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 Loaders

Module client/theme-switcher/theme-switcher

Index

Interfaces

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

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 e7730c0b..d722ea57 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | React18 Loaders

Module constants

Index

Interfaces

ThemeState +constants | React18 Loaders

Module constants

Index

Interfaces

ThemeState

Type Aliases

ColorSchemePreference

Variables

DEFAULT_ID

Functions

useRGSMinify diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 3a680bdb..dad02bda 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,3 +1,3 @@ -hooks/use-theme | React18 Loaders

Module hooks/use-theme

Index

Interfaces

UseTheme +hooks/use-theme | React18 Loaders

Module hooks/use-theme

Index

Interfaces

UseTheme

Functions

useTheme

Settings

Member Visibility
diff --git a/docs/modules/hooks_use_theme_test.html b/docs/modules/hooks_use_theme_test.html index 37adaf44..5359624f 100644 --- a/docs/modules/hooks_use_theme_test.html +++ b/docs/modules/hooks_use_theme_test.html @@ -1 +1 @@ -hooks/use-theme.test | React18 Loaders

Module hooks/use-theme.test

Settings

Member Visibility
+hooks/use-theme.test | React18 Loaders

Module hooks/use-theme.test

Settings

Member Visibility
diff --git a/docs/modules/server_force_theme_force_theme.html b/docs/modules/server_force_theme_force_theme.html index e13a7a71..7757b7af 100644 --- a/docs/modules/server_force_theme_force_theme.html +++ b/docs/modules/server_force_theme_force_theme.html @@ -1,3 +1,3 @@ -server/force-theme/force-theme | React18 Loaders

Module server/force-theme/force-theme

Index

Modules

<internal> +server/force-theme/force-theme | React18 Loaders

Module server/force-theme/force-theme

Index

Modules

<internal>

Functions

ForceTheme

Settings

Member Visibility
diff --git a/docs/modules/server_server_target_server_target.html b/docs/modules/server_server_target_server_target.html index e4800ab4..bffe4d0e 100644 --- a/docs/modules/server_server_target_server_target.html +++ b/docs/modules/server_server_target_server_target.html @@ -1,3 +1,3 @@ -server/server-target/server-target | React18 Loaders

Module server/server-target/server-target

Index

Modules

<internal> +server/server-target/server-target | React18 Loaders

Module server/server-target/server-target

Index

Modules

<internal>

Functions

ServerTarget

Settings

Member Visibility
diff --git a/docs/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index f19227b5..da396f5c 100644 --- a/docs/types/constants.ColorSchemePreference.html +++ b/docs/types/constants.ColorSchemePreference.html @@ -1 +1 @@ -ColorSchemePreference | React18 Loaders

Type Alias ColorSchemePreference

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

Settings

Member Visibility
+ColorSchemePreference | React18 Loaders

Type Alias ColorSchemePreference

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

Settings

Member Visibility
diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index 503b5d28..2ddf4e33 100644 --- a/docs/variables/constants.DEFAULT_ID.html +++ b/docs/variables/constants.DEFAULT_ID.html @@ -1,2 +1,2 @@ DEFAULT_ID | React18 Loaders

Variable DEFAULT_IDConst

DEFAULT_ID = "nthul"

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

-

Settings

Member Visibility
+

Settings

Member Visibility