diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index d8810b71..2146431d 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ 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 7172936d..fc657f1b 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

\ No newline at end of file +

Parameters

Returns null

Settings

Member Visibility

Theme

\ 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 06c7ba36..e4e288f1 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ 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 b9ceea8e..032135d7 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

Function ForceTheme

Settings

Member Visibility

Theme

On This Page

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

Function ForceTheme

Settings

Member Visibility

Theme

On This Page

ForceTheme
\ 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 15dc044d..fb7fbec8 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ 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 658db21f..1fc85d31 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

sizeskipSystemtargetId
\ 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

sizeskipSystemtargetId
\ 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 acb26893..5d796432 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

resolvedColorSchemestylestargetstheme
\ 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

resolvedColorSchemestylestargetstheme
\ 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 7c28ccc1..b2d4005f 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 imported from CSS/SCSS modules, 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

dontSyncsetThemeStatestylestargetIdthemeTransition
\ No newline at end of file +

setThemeState

setThemeState: SetStateAction<ThemeState>

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, 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

dontSyncsetThemeStatestylestargetIdthemeTransition
\ 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 5beb9ed0..99f63c07 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 imported from CSS/SCSS modules, 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

dontSyncstylestargetIdthemeTransition
\ No newline at end of file +

Optional styles

styles?: Record<string, string>

provide styles object imported from CSS/SCSS modules, 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

dontSyncstylestargetIdthemeTransition
\ 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 3347ccf6..ba454a91 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

dontSyncstylestargetIdthemeState
\ 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

dontSyncstylestargetIdthemeState
\ No newline at end of file diff --git a/docs/interfaces/constants.ThemeState.html b/docs/interfaces/constants.ThemeState.html index 57aebd1b..108394fb 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

colorSchemePreferencesystemColorSchemetheme
\ No newline at end of file +

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

colorSchemePreferencesystemColorSchemetheme
\ 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 f7c144ee..c3c98789 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

colorSchemePreferenceresolvedColorSchemesetColorSchemePreferencesetThemesystemColorSchemetheme
\ 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

colorSchemePreferenceresolvedColorSchemesetColorSchemePreferencesetThemesystemColorSchemetheme
\ 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 25510805..82460f04 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

\ 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 db5bfcbc..3587f05f 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 925a5805..9c07e8ae 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 6c29b04f..a14a331a 100644 --- a/docs/modules/declaration.html +++ b/docs/modules/declaration.html @@ -1 +1 @@ -declaration | Code Documentation

Module declaration

Settings

Member Visibility

Theme

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

Module declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/hooks.html b/docs/modules/hooks.html index 859af481..69d9046d 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

UseThemeuseTheme
\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 94e6db9e..1eda06d1 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

\ 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 71ea095c..4cd95a4d 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

ForceTheme

Settings

Member Visibility

Theme

\ 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 61b735ed..2fba4612 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

\ No newline at end of file diff --git a/docs/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index ba425238..9351d272 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

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

Type alias ColorSchemePreference

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

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index a63ba7ef..9972144c 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ 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 feedcef4..930757c4 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

\ 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

\ No newline at end of file