From fa4b19ed7e5fd83b2e282cfdc4fad47cc86dc7dd Mon Sep 17 00:00:00 2001 From: react18-tools Date: Wed, 28 Feb 2024 00:29:10 +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 +- ...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_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 +- 21 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index f4b84089..6a2195bc 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 />
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 460b7f58..75b5a37f 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

Function ThemeSwitcher

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns null

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 825e1208..743c0b33 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

Function useTheme

  • useTheme(targetId?): UseTheme

  • 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

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 b1564fca..3da2637c 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

Function ServerTarget

  • ServerTarget(__namedParameters): Element

  • Server Side target for avoiding flash of un-themed content.

    Parameters

    • __namedParameters: ServerTargetProps

    Returns Element

    Example

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 7f9bb23d..2403f532 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

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

Properties

size? +ColorSwitchProps | Code Documentation

Interface ColorSwitchProps

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

Properties

size? skipSystem? targetId?

Properties

Optional size

size?: number

Diameter of the color switch

-

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

Optional targetId

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

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

Optional targetId

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

Theme

On This Page

Generated using TypeDoc

\ 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 415caf60..fdb15785 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

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

Properties

resolvedColorScheme +ApplyClassesProps | Code Documentation

Interface ApplyClassesProps

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

Properties

resolvedColorScheme styles? targets theme -

Properties

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

Optional styles

styles?: Record<string, string>

targets

targets: (null | HTMLElement)[]

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

Optional styles

styles?: Record<string, string>

targets

targets: (null | HTMLElement)[]

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 2da1fa6a..69ce8f54 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

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

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

Hierarchy (view full)

Properties

dontSync? setThemeState styles? targetId? themeTransition?

Properties

Optional dontSync

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-

setThemeState

setThemeState: SetStateAction<ThemeState>

Optional styles

styles?: Record<string, string>

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

-

Optional targetId

targetId?: string

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

-

Optional themeTransition

themeTransition?: string

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

setThemeState

setThemeState: SetStateAction<ThemeState>

Optional styles

styles?: Record<string, string>

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

+

Optional targetId

targetId?: string

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

+

Optional themeTransition

themeTransition?: string

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 4edd5bcf..236cca8d 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

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

Hierarchy (view full)

Properties

dontSync? +ThemeSwitcherProps | Code Documentation

Interface ThemeSwitcherProps

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

Hierarchy (view full)

Properties

dontSync? styles? targetId? themeTransition?

Properties

Optional dontSync

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-

Optional styles

styles?: Record<string, string>

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

-

Optional targetId

targetId?: string

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

-

Optional themeTransition

themeTransition?: string

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional styles

styles?: Record<string, string>

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

+

Optional targetId

targetId?: string

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

+

Optional themeTransition

themeTransition?: string

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 8c6994f2..408d82f7 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

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

Properties

dontSync? +UpdateDOMProps | Code Documentation

Interface UpdateDOMProps

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

Properties

dontSync? styles? targetId? themeState -

Properties

Optional dontSync

dontSync?: boolean

Optional styles

styles?: Record<string, string>

Optional targetId

targetId?: string

themeState

themeState: ThemeState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional dontSync

dontSync?: boolean

Optional styles

styles?: Record<string, string>

Optional targetId

targetId?: string

themeState

themeState: ThemeState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/constants.ThemeState.html b/docs/interfaces/constants.ThemeState.html index 1d57bb8e..0488871e 100644 --- a/docs/interfaces/constants.ThemeState.html +++ b/docs/interfaces/constants.ThemeState.html @@ -1,4 +1,4 @@ -ThemeState | Code Documentation

Interface ThemeState

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

Properties

colorSchemePreference +ThemeState | Code Documentation

Interface ThemeState

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

Properties

colorSchemePreference systemColorScheme theme -

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 a0629128..ce27d918 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

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

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

Properties

colorSchemePreference resolvedColorScheme setColorSchemePreference setTheme systemColorScheme theme -

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme

setTheme: ((theme) => void)

Type declaration

    • (theme): void

    • Parameters

      • theme: string

      Returns void

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme

setTheme: ((theme) => void)

Type declaration

    • (theme): void

    • Parameters

      • theme: string

      Returns void

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ 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 fa0dd031..6b39d557 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

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps

Functions

ColorSwitch

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 bf340865..5a0e66e6 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 ad8c1a79..4411913b 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | Code Documentation

Module constants

Index

Interfaces

ThemeState +constants | Code Documentation

Module constants

Index

Interfaces

ThemeState

Type Aliases

ColorSchemePreference

Variables

DEFAULT_ID DEFAULT_THEME_STATE diff --git a/docs/modules/declaration.html b/docs/modules/declaration.html index df58bdad..2b91bb86 100644 --- a/docs/modules/declaration.html +++ b/docs/modules/declaration.html @@ -1 +1 @@ -declaration | Code Documentation

Module declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Module declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/hooks.html b/docs/modules/hooks.html index 46595087..a5125d16 100644 --- a/docs/modules/hooks.html +++ b/docs/modules/hooks.html @@ -1,3 +1,3 @@ -hooks | Code Documentation

Module hooks

References

UseTheme +hooks | Code Documentation

Module hooks

References

UseTheme useTheme

References

UseTheme

Re-exports UseTheme

useTheme

Re-exports useTheme

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index d48e0c2d..d88bb6e0 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

UseTheme

Functions

useTheme

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 675119b9..4b858027 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

Module server/server-target/server-target

Index

Functions

ServerTarget

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index 0470d297..917b7236 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"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ColorSchemePreference

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index 6c5057e6..199aef8f 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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 d8104594..9227e4d4 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file