diff --git a/docs/functions/client_color-switch_color-switch.ColorSwitch.html b/docs/functions/client_color-switch_color-switch.ColorSwitch.html index 5bdad587..8dc6009b 100644 --- a/docs/functions/client_color-switch_color-switch.ColorSwitch.html +++ b/docs/functions/client_color-switch_color-switch.ColorSwitch.html @@ -10,4 +10,4 @@

Source

-

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 08294f0b..423e8a5c 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 82bb43f5..7b54120d 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 0c690e9d..6498fc62 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?: string): 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 5c327b48..bd9606ba 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 cbf45950..767df878 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 a3bdb80b..8e958d4f 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 029193d6..6769bfe3 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 cfb5be02..f34730f8 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 0bfd9c4f..dd7e4b64 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 51803334..89fc1216 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 6d31a41f..f6b6cc26 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/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index 35edfa8d..5fc4d15e 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 ca3cba7c..75be16f1 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/pnpm-lock.yaml b/pnpm-lock.yaml index b1775850..5537812d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1149,12 +1149,12 @@ packages: resolution: {integrity: sha512-eohesHH8WFRUprDNyEREgqP6beG6htMeUYeCpkEgBCieCMme5r9zFWjzAJp//9S+Kub4rqE+jXe9Cp1a7IYIIA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@eslint/object-schema@2.1.4': - resolution: {integrity: sha512-BsWiH1yFGjXXS2yvrf5LyuoSIIbPrGUWob917o+BTKuZ7qJdxX8aJLRxs1fS9n6r7vESrq1OUqb68dANcFXuQQ==} + '@eslint/object-schema@2.1.5': + resolution: {integrity: sha512-o0bhxnL89h5Bae5T318nFoFzGy+YE5i/gGkoPAgkmTVdRKTiv3p8JHevPiPaMwoloKfEiiaHlawCqaZMqRm+XQ==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@eslint/plugin-kit@0.2.3': - resolution: {integrity: sha512-2b/g5hRmpbb1o4GnTZax9N9m0FXzz9OV42ZzI4rDDMDuHUqigAiQCEWChBWCY4ztAGVRjoWT19v0yMmc5/L5kA==} + '@eslint/plugin-kit@0.2.4': + resolution: {integrity: sha512-zSkKow6H5Kdm0ZUQUB2kV5JIXqoG0+uH5YADhaEHswm664N9Db8dXSi0nMJpacpMf+MyyglF1vnZohpEg5yUtg==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} '@gerrit0/mini-shiki@1.24.1': @@ -3780,8 +3780,8 @@ packages: globrex@0.1.2: resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} - gopd@1.1.0: - resolution: {integrity: sha512-FQoVQnqcdk4hVM4JN1eromaun4iuS34oStkdlLENLdpULsuQcTyXj8w7ayhuUfPwEYZ1ZOooOTT6fdA9Vmx/RA==} + gopd@1.2.0: + resolution: {integrity: sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==} engines: {node: '>= 0.4'} graceful-fs@4.2.11: @@ -5300,8 +5300,8 @@ packages: package-json-from-dist@1.0.1: resolution: {integrity: sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==} - package-manager-detector@0.2.6: - resolution: {integrity: sha512-9vPH3qooBlYRJdmdYP00nvjZOulm40r5dhtal8st18ctf+6S1k7pi5yIHLvI4w5D70x0Y+xdVD9qITH0QO/A8A==} + package-manager-detector@0.2.7: + resolution: {integrity: sha512-g4+387DXDKlZzHkP+9FLt8yKj8+/3tOkPv7DVTJGGRm00RkEWgqbFstX1mXJ4M0VDYhUqsTOiISqNOJnhAu3PQ==} pako@0.2.9: resolution: {integrity: sha512-NUcwaKxUxWrZLpDG+z/xZaCgQITkA/Dv4V/T6bw7VON6l1Xz/VnrBqrYjZQ12TamKHzITTfOEIYUj48y2KXImA==} @@ -7434,7 +7434,7 @@ snapshots: fs-extra: 7.0.1 mri: 1.2.0 p-limit: 2.3.0 - package-manager-detector: 0.2.6 + package-manager-detector: 0.2.7 picocolors: 1.1.1 resolve-from: 5.0.0 semver: 7.6.3 @@ -7751,7 +7751,7 @@ snapshots: '@eslint/config-array@0.18.0': dependencies: - '@eslint/object-schema': 2.1.4 + '@eslint/object-schema': 2.1.5 debug: 4.3.7 minimatch: 3.1.2 transitivePeerDependencies: @@ -7789,9 +7789,9 @@ snapshots: '@eslint/js@9.12.0': {} - '@eslint/object-schema@2.1.4': {} + '@eslint/object-schema@2.1.5': {} - '@eslint/plugin-kit@0.2.3': + '@eslint/plugin-kit@0.2.4': dependencies: levn: 0.4.1 @@ -9901,7 +9901,7 @@ snapshots: dependencies: es-define-property: 1.0.0 es-errors: 1.3.0 - gopd: 1.1.0 + gopd: 1.2.0 define-properties@1.2.1: dependencies: @@ -10047,7 +10047,7 @@ snapshots: get-intrinsic: 1.2.4 get-symbol-description: 1.0.2 globalthis: 1.0.4 - gopd: 1.1.0 + gopd: 1.2.0 has-property-descriptors: 1.0.2 has-proto: 1.1.0 has-symbols: 1.1.0 @@ -10094,7 +10094,7 @@ snapshots: function-bind: 1.1.2 get-intrinsic: 1.2.4 globalthis: 1.0.4 - gopd: 1.1.0 + gopd: 1.2.0 has-property-descriptors: 1.0.2 has-proto: 1.1.0 has-symbols: 1.1.0 @@ -10519,7 +10519,7 @@ snapshots: '@eslint/core': 0.6.0 '@eslint/eslintrc': 3.2.0 '@eslint/js': 9.12.0 - '@eslint/plugin-kit': 0.2.3 + '@eslint/plugin-kit': 0.2.4 '@humanfs/node': 0.16.6 '@humanwhocodes/module-importer': 1.0.1 '@humanwhocodes/retry': 0.3.1 @@ -10971,7 +10971,7 @@ snapshots: globalthis@1.0.4: dependencies: define-properties: 1.2.1 - gopd: 1.1.0 + gopd: 1.2.0 globby@11.1.0: dependencies: @@ -10992,9 +10992,7 @@ snapshots: globrex@0.1.2: {} - gopd@1.1.0: - dependencies: - get-intrinsic: 1.2.4 + gopd@1.2.0: {} graceful-fs@4.2.11: {} @@ -11349,7 +11347,7 @@ snapshots: is-regex@1.2.0: dependencies: call-bind: 1.0.7 - gopd: 1.1.0 + gopd: 1.2.0 has-tostringtag: 1.0.2 hasown: 2.0.2 @@ -13150,7 +13148,7 @@ snapshots: package-json-from-dist@1.0.1: {} - package-manager-detector@0.2.6: {} + package-manager-detector@0.2.7: {} pako@0.2.9: {} @@ -13642,7 +13640,7 @@ snapshots: es-abstract: 1.23.5 es-errors: 1.3.0 get-intrinsic: 1.2.4 - gopd: 1.1.0 + gopd: 1.2.0 which-builtin-type: 1.2.0 regenerator-runtime@0.14.1: {} @@ -13898,7 +13896,7 @@ snapshots: es-errors: 1.3.0 function-bind: 1.1.2 get-intrinsic: 1.2.4 - gopd: 1.1.0 + gopd: 1.2.0 has-property-descriptors: 1.0.2 set-function-name@2.0.2: @@ -14097,7 +14095,7 @@ snapshots: es-errors: 1.3.0 es-object-atoms: 1.0.0 get-intrinsic: 1.2.4 - gopd: 1.1.0 + gopd: 1.2.0 has-symbols: 1.1.0 internal-slot: 1.0.7 regexp.prototype.flags: 1.5.3 @@ -14492,7 +14490,7 @@ snapshots: dependencies: call-bind: 1.0.7 for-each: 0.3.3 - gopd: 1.1.0 + gopd: 1.2.0 has-proto: 1.1.0 is-typed-array: 1.1.13 @@ -14501,7 +14499,7 @@ snapshots: available-typed-arrays: 1.0.7 call-bind: 1.0.7 for-each: 0.3.3 - gopd: 1.1.0 + gopd: 1.2.0 has-proto: 1.1.0 is-typed-array: 1.1.13 reflect.getprototypeof: 1.0.7 @@ -14510,7 +14508,7 @@ snapshots: dependencies: call-bind: 1.0.7 for-each: 0.3.3 - gopd: 1.1.0 + gopd: 1.2.0 is-typed-array: 1.1.13 possible-typed-array-names: 1.0.0 reflect.getprototypeof: 1.0.7 @@ -15023,7 +15021,7 @@ snapshots: available-typed-arrays: 1.0.7 call-bind: 1.0.7 for-each: 0.3.3 - gopd: 1.1.0 + gopd: 1.2.0 has-tostringtag: 1.0.2 which@1.3.1: