From 8fc9ec668cb957fe7eb2fc27f7ee2bb8d661a99c Mon Sep 17 00:00:00 2001 From: react18-tools Date: Sun, 19 May 2024 08:08:57 +0000 Subject: [PATCH] upgrade deps && docs --- .../client_color_switch_color_switch.ColorSwitch.html | 2 +- ...nt_theme_switcher_theme_switcher.ThemeSwitcher.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 +- ...ent_color_switch_color_switch.ColorSwitchProps.html | 8 ++++---- ...heme_switcher_theme_switcher.ApplyClassesProps.html | 4 ++-- ...e_switcher_theme_switcher.LoadSyncedStateProps.html | 10 +++++----- ...eme_switcher_theme_switcher.ThemeSwitcherProps.html | 10 +++++----- ...t_theme_switcher_theme_switcher.UpdateDOMProps.html | 4 ++-- docs/interfaces/constants.ThemeState.html | 4 ++-- docs/interfaces/hooks_use_theme.UseTheme.html | 4 ++-- 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/declaration.html | 2 +- docs/modules/hooks.html | 2 +- docs/modules/hooks_use_theme.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 +- docs/variables/constants.DEFAULT_THEME_STATE.html | 2 +- 23 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 be75f241..1e9f0553 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -5,4 +5,4 @@

Custom size & skipSystem

<ColorSwitch size={20} skipSystem />
 
-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html index 2d89c394..b3105599 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 | Code Documentation
\ No newline at end of file +

Parameters

Returns null

\ No newline at end of file diff --git a/docs/functions/hooks_use_theme.useTheme-1.html b/docs/functions/hooks_use_theme.useTheme-1.html index 20ef4ac7..2f7cf7c5 100644 --- a/docs/functions/hooks_use_theme.useTheme-1.html +++ b/docs/functions/hooks_use_theme.useTheme-1.html @@ -1,4 +1,4 @@ useTheme | Code Documentation
  • use this hook to gain access to theme state and setters from your components.

    Parameters

    • Optional targetId: string

      targetId corresponding to ThemeSwitcher and others tied to specific container.

    Returns UseTheme

    themeState and setter fucntions

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/server_force_theme_force_theme.ForceTheme.html b/docs/functions/server_force_theme_force_theme.ForceTheme.html index dbda464f..63c62442 100644 --- a/docs/functions/server_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/server_force_theme_force_theme.ForceTheme.html @@ -1 +1 @@ -ForceTheme | Code Documentation
\ No newline at end of file +ForceTheme | Code Documentation
\ No newline at end of file diff --git a/docs/functions/server_server_target_server_target.ServerTarget.html b/docs/functions/server_server_target_server_target.ServerTarget.html index 32b9e0a5..2fd3b22b 100644 --- a/docs/functions/server_server_target_server_target.ServerTarget.html +++ b/docs/functions/server_server_target_server_target.ServerTarget.html @@ -1,4 +1,4 @@ ServerTarget | Code Documentation
  • Server Side target for avoiding flash of un-themed content.

    Parameters

    • __namedParameters: ServerTargetProps

    Returns Element

    Example

    <html>
    ...
    <body>
    <ServerTarget />
    ...
    </body>
    </html>
    -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html index 1f40a32c..7abde1d2 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,7 +1,7 @@ -ColorSwitchProps | Code Documentation
interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetId?: string;
}

Properties

size? +ColorSwitchProps | Code Documentation
interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetId?: string;
}

Properties

size?: number

Diameter of the color switch

-
skipSystem?: boolean

Skip system colorScheme while toggling

-
targetId?: string

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

-
\ No newline at end of file +
skipSystem?: boolean

Skip system colorScheme while toggling

+
targetId?: string

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

+
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.ApplyClassesProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.ApplyClassesProps.html index d67bcd66..d8f0bb94 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ApplyClassesProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ApplyClassesProps.html @@ -1,5 +1,5 @@ -ApplyClassesProps | Code Documentation
interface ApplyClassesProps {
    resolvedColorScheme: "dark" | "light";
    styles?: Record<string, string>;
    targets: (null | HTMLElement)[];
    theme: string;
}

Properties

resolvedColorScheme +ApplyClassesProps | Code Documentation
interface ApplyClassesProps {
    resolvedColorScheme: "dark" | "light";
    styles?: Record<string, string>;
    targets: (null | HTMLElement)[];
    theme: string;
}

Properties

resolvedColorScheme: "dark" | "light"
styles?: Record<string, string>
targets: (null | HTMLElement)[]
theme: string
\ No newline at end of file +

Properties

resolvedColorScheme: "dark" | "light"
styles?: Record<string, string>
targets: (null | HTMLElement)[]
theme: string
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html index 7b7011b5..899dbf48 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html @@ -1,10 +1,10 @@ -LoadSyncedStateProps | Code Documentation
interface LoadSyncedStateProps {
    dontSync?: boolean;
    setThemeState: SetStateAction<ThemeState>;
    styles?: Record<string, string>;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync? +LoadSyncedStateProps | Code Documentation
interface LoadSyncedStateProps {
    dontSync?: boolean;
    setThemeState: SetStateAction<ThemeState>;
    styles?: Record<string, string>;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-
setThemeState: SetStateAction<ThemeState>
styles?: Record<string, string>

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

-
targetId?: string

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

-
themeTransition?: string

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

-
\ No newline at end of file +
setThemeState: SetStateAction<ThemeState>
styles?: Record<string, string>

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

+
targetId?: string

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

+
themeTransition?: string

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

+
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html index a4ebbed0..7c0aec71 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 | Code Documentation
interface ThemeSwitcherProps {
    dontSync?: boolean;
    styles?: Record<string, string>;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

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

Hierarchy (view full)

Properties

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-
styles?: Record<string, string>

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

-
targetId?: string

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

-
themeTransition?: string

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

-
\ No newline at end of file +
styles?: Record<string, string>

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

+
targetId?: string

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

+
themeTransition?: string

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

+
\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html index 248765c3..fc6075f9 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html @@ -1,5 +1,5 @@ -UpdateDOMProps | Code Documentation
interface UpdateDOMProps {
    dontSync?: boolean;
    styles?: Record<string, string>;
    targetId?: string;
    themeState: ThemeState;
}

Properties

dontSync? +UpdateDOMProps | Code Documentation
interface UpdateDOMProps {
    dontSync?: boolean;
    styles?: Record<string, string>;
    targetId?: string;
    themeState: ThemeState;
}

Properties

dontSync?: boolean
styles?: Record<string, string>
targetId?: string
themeState: ThemeState
\ No newline at end of file +

Properties

dontSync?: boolean
styles?: Record<string, string>
targetId?: string
themeState: ThemeState
\ No newline at end of file diff --git a/docs/interfaces/constants.ThemeState.html b/docs/interfaces/constants.ThemeState.html index db3c1500..e3559343 100644 --- a/docs/interfaces/constants.ThemeState.html +++ b/docs/interfaces/constants.ThemeState.html @@ -1,4 +1,4 @@ -ThemeState | Code Documentation
interface ThemeState {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference +ThemeState | Code Documentation
interface ThemeState {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference: ColorSchemePreference
systemColorScheme: "dark" | "light"
theme: string
\ No newline at end of file +

Properties

colorSchemePreference: ColorSchemePreference
systemColorScheme: "dark" | "light"
theme: string
\ No newline at end of file diff --git a/docs/interfaces/hooks_use_theme.UseTheme.html b/docs/interfaces/hooks_use_theme.UseTheme.html index ae74df71..650c9578 100644 --- a/docs/interfaces/hooks_use_theme.UseTheme.html +++ b/docs/interfaces/hooks_use_theme.UseTheme.html @@ -1,7 +1,7 @@ -UseTheme | Code Documentation
interface UseTheme {
    colorSchemePreference: ColorSchemePreference;
    resolvedColorScheme: "dark" | "light";
    setColorSchemePreference: ((colorSchemePreference) => void);
    setTheme: ((theme) => void);
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

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

Properties

colorSchemePreference: ColorSchemePreference
resolvedColorScheme: "dark" | "light"
setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme: ((theme) => void)

Type declaration

    • (theme): void
    • Parameters

      • theme: string

      Returns void

systemColorScheme: "dark" | "light"
theme: string
\ No newline at end of file +

Properties

colorSchemePreference: ColorSchemePreference
resolvedColorScheme: "dark" | "light"
setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme: ((theme) => void)

Type declaration

    • (theme): void
    • Parameters

      • theme: string

      Returns void

systemColorScheme: "dark" | "light"
theme: string
\ No newline at end of file diff --git a/docs/modules/client_color_switch_color_switch.html b/docs/modules/client_color_switch_color_switch.html index 052704d1..14a5f5ba 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 | Code Documentation

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps +client/color-switch/color-switch | Code Documentation
\ No newline at end of file diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index 5e5fc0d0..2fcf1e88 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,4 +1,4 @@ -client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

ApplyClassesProps +client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

ApplyClassesProps LoadSyncedStateProps ThemeSwitcherProps UpdateDOMProps diff --git a/docs/modules/constants.html b/docs/modules/constants.html index 9d2f40ae..2a66eee9 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | Code Documentation

Index

Interfaces

ThemeState +constants | Code Documentation

Index

Interfaces

Type Aliases

Variables

DEFAULT_ID DEFAULT_THEME_STATE diff --git a/docs/modules/declaration.html b/docs/modules/declaration.html index 7d6fd042..6831e1a2 100644 --- a/docs/modules/declaration.html +++ b/docs/modules/declaration.html @@ -1 +1 @@ -declaration | Code Documentation
\ No newline at end of file +declaration | Code Documentation
\ No newline at end of file diff --git a/docs/modules/hooks.html b/docs/modules/hooks.html index ac408095..503d682b 100644 --- a/docs/modules/hooks.html +++ b/docs/modules/hooks.html @@ -1,3 +1,3 @@ -hooks | Code Documentation

References

UseTheme +hooks | Code Documentation

References

References

Re-exports UseTheme
Re-exports useTheme
\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 3cd676c6..0668f0fb 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,3 +1,3 @@ -hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Interfaces

UseTheme +hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Interfaces

Functions

\ No newline at end of file diff --git a/docs/modules/server_force_theme_force_theme.html b/docs/modules/server_force_theme_force_theme.html index 17d65441..ed773dda 100644 --- a/docs/modules/server_force_theme_force_theme.html +++ b/docs/modules/server_force_theme_force_theme.html @@ -1,2 +1,2 @@ -server/force-theme/force-theme | Code Documentation

Module server/force-theme/force-theme

Index

Functions

ForceTheme +server/force-theme/force-theme | Code Documentation

Module server/force-theme/force-theme

Index

Functions

\ No newline at end of file diff --git a/docs/modules/server_server_target_server_target.html b/docs/modules/server_server_target_server_target.html index d1038cd0..87e46304 100644 --- a/docs/modules/server_server_target_server_target.html +++ b/docs/modules/server_server_target_server_target.html @@ -1,2 +1,2 @@ -server/server-target/server-target | Code Documentation

Module server/server-target/server-target

Index

Functions

ServerTarget +server/server-target/server-target | Code Documentation
\ No newline at end of file diff --git a/docs/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index 7b076e39..0ce36f5d 100644 --- a/docs/types/constants.ColorSchemePreference.html +++ b/docs/types/constants.ColorSchemePreference.html @@ -1 +1 @@ -ColorSchemePreference | Code Documentation

Type alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | "light"
\ No newline at end of file +ColorSchemePreference | Code Documentation

Type alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | "light"
\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index f78737a5..bbf792b0 100644 --- a/docs/variables/constants.DEFAULT_ID.html +++ b/docs/variables/constants.DEFAULT_ID.html @@ -1,2 +1,2 @@ DEFAULT_ID | Code Documentation

Variable DEFAULT_IDConst

DEFAULT_ID: "nthul" = "nthul"

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

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_THEME_STATE.html b/docs/variables/constants.DEFAULT_THEME_STATE.html index 5ac58907..1d7cadf8 100644 --- a/docs/variables/constants.DEFAULT_THEME_STATE.html +++ b/docs/variables/constants.DEFAULT_THEME_STATE.html @@ -1 +1 @@ -DEFAULT_THEME_STATE | Code Documentation

Variable DEFAULT_THEME_STATEConst

DEFAULT_THEME_STATE: {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
} = ...

Type declaration

\ No newline at end of file +DEFAULT_THEME_STATE | Code Documentation

Variable DEFAULT_THEME_STATEConst

DEFAULT_THEME_STATE: {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
} = ...

Type declaration

\ No newline at end of file