From a2b2b1de58afc32f8c761095ff9963b7178d77e8 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Sun, 17 Nov 2024 00:58:55 +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 +- package.json | 2 +- pnpm-lock.yaml | 10 +++++----- 23 files changed, 44 insertions(+), 44 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index 54787273..38062093 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 fc7b34cd..59766d97 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 b5dc52c9..6f1c7e3e 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 f0132d75..969729e2 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 baf6d66b..b4d8e5fa 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 a32fe7d9..7949c694 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 320b7cba..eea32f20 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 c536ec43..15ea018c 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 eb4a8679..7cb0ec57 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 bde13c3e..3289257a 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 6e688e3a..8832753f 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 cf05a16d..9846d064 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 6c45d078..44c8d96d 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 cd3702f4..f29e3a03 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 2d92ae53..ba23a553 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 74b02dd8..7fe393d5 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 c1b0320d..40ec494a 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 18cefae0..e530d5a9 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 1f0f3052..a901ca2c 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 239753f3..9d82ab90 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 cf7d5884..c2df713c 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
diff --git a/package.json b/package.json index 690b2ab2..635fa7ee 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "typedoc": "^0.26.11", "typedoc-plugin-extras": "^3.1.0", "typedoc-plugin-inline-sources": "^1.1.0", - "typedoc-plugin-mdn-links": "^3.3.7", + "typedoc-plugin-mdn-links": "^3.3.8", "typedoc-plugin-missing-exports": "^3.0.2", "typedoc-plugin-rename-defaults": "^0.7.1", "typedoc-plugin-zod": "^1.2.1" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e82b807d..78c42762 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -37,8 +37,8 @@ importers: specifier: ^1.1.0 version: 1.1.0(typedoc@0.26.11(typescript@5.6.3)) typedoc-plugin-mdn-links: - specifier: ^3.3.7 - version: 3.3.7(typedoc@0.26.11(typescript@5.6.3)) + specifier: ^3.3.8 + version: 3.3.8(typedoc@0.26.11(typescript@5.6.3)) typedoc-plugin-missing-exports: specifier: ^3.0.2 version: 3.0.2(typedoc@0.26.11(typescript@5.6.3)) @@ -6594,8 +6594,8 @@ packages: peerDependencies: typedoc: 0.25.x || 0.26.x - typedoc-plugin-mdn-links@3.3.7: - resolution: {integrity: sha512-iFSnYj3XPuc0wh0/VjU2M/sHtNv5pSEysUXrylHxgd5PqTAOZTUswJAcbB7shg+SfxMCqGaiyA0duNmnGs/LQg==} + typedoc-plugin-mdn-links@3.3.8: + resolution: {integrity: sha512-Aewg+SW7hBdffRpT6WnpRwWthoaF9irlzXDKRyvcDVekPZSFujOlh690SV6eCgqrtP7GBJmN0TVeJUq6+6rb1w==} peerDependencies: typedoc: '>= 0.23.14 || 0.24.x || 0.25.x || 0.26.x' @@ -14613,7 +14613,7 @@ snapshots: dependencies: typedoc: 0.26.11(typescript@5.6.3) - typedoc-plugin-mdn-links@3.3.7(typedoc@0.26.11(typescript@5.6.3)): + typedoc-plugin-mdn-links@3.3.8(typedoc@0.26.11(typescript@5.6.3)): dependencies: typedoc: 0.26.11(typescript@5.6.3)