From 72adaedecd369037d99933c88d88cc1ea09f4389 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Fri, 22 Nov 2024 16:19:40 +0000 Subject: [PATCH] upgrade deps && docs --- ..._color_switch_color_switch.ColorSwitch.html | 2 +- ...me_force_color_scheme.ForceColorScheme.html | 2 +- ...ent_force_theme_force_theme.ForceTheme.html | 2 +- .../client_switcher_switcher.Switcher.html | 2 +- ..._switcher_theme_switcher.ThemeSwitcher.html | 2 +- docs/functions/hooks_use_theme.useTheme.html | 2 +- ...r_switch_color_switch.ColorSwitchProps.html | 6 +++--- ...cher_theme_switcher.ThemeSwitcherProps.html | 14 +++++++------- .../hooks_use_theme.UseThemeYield.html | 6 +++--- .../client_color_switch_color_switch.html | 2 +- ..._force_color_scheme_force_color_scheme.html | 2 +- .../client_force_theme_force_theme.html | 2 +- docs/modules/client_switcher_switcher.html | 2 +- .../client_theme_switcher_theme_switcher.html | 2 +- docs/modules/hooks_use_theme.html | 2 +- docs/modules/types.html | 2 +- docs/types/types.ColorSchemeType.html | 2 +- docs/types/types.ResolvedColorSchemeType.html | 2 +- examples/vite/package.json | 2 +- pnpm-lock.yaml | 18 +++++++++--------- 20 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 0590c5bc..7ea66ed0 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -6,4 +6,4 @@ 
<ColorSwitch size={20} skipSystem />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html index fc40e1b3..b24a9295 100644 --- a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html +++ b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html @@ -1,2 +1,2 @@ ForceColorScheme | Nextjs Themes

Function ForceColorScheme

Force color scheme on a page

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_force_theme_force_theme.ForceTheme.html b/docs/functions/client_force_theme_force_theme.ForceTheme.html index 8095783c..2db576f6 100644 --- a/docs/functions/client_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/client_force_theme_force_theme.ForceTheme.html @@ -1,2 +1,2 @@ ForceTheme | Nextjs Themes

Function ForceTheme

Force theme on a page

-
  • ForceTheme(props): null

  • Parameters

    • props: {
          targetSelector?: string;
          theme: string;
      }
      • OptionaltargetSelector?: string
      • theme: string

    Returns null

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/client_switcher_switcher.Switcher.html b/docs/functions/client_switcher_switcher.Switcher.html index a78a93fe..4aeffcb6 100644 --- a/docs/functions/client_switcher_switcher.Switcher.html +++ b/docs/functions/client_switcher_switcher.Switcher.html @@ -3,4 +3,4 @@

Example

<Switcher targetSelector="#container1" />
-

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 736d7c1b..a732a376 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -3,4 +3,4 @@

Example

<ThemeSwitcher [...props] />
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/hooks_use_theme.useTheme.html b/docs/functions/hooks_use_theme.useTheme.html index 23d091c6..3b0e2fe3 100644 --- a/docs/functions/hooks_use_theme.useTheme.html +++ b/docs/functions/hooks_use_theme.useTheme.html @@ -1,4 +1,4 @@ useTheme | Nextjs Themes

Function useTheme

Example

const [] = useTheme(options);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html index 9172b5b4..24602125 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,6 +1,6 @@ -ColorSwitchProps | Nextjs Themes

Interface ColorSwitchProps

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

Hierarchy

Properties

size? +ColorSwitchProps | Nextjs Themes

Interface ColorSwitchProps

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

Hierarchy

Properties

size? skipSystem? targetSelector?

Properties

Optionalsize

size?: number

Diameter of the color switch

-

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

OptionaltargetSelector

targetSelector?: string

Settings

Member Visibility

On This Page

Properties
+

OptionalskipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

OptionaltargetSelector

targetSelector?: string

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 0c0c12e8..d221ac7a 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,4 +1,4 @@ -ThemeSwitcherProps | Nextjs Themes

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    nonce?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? +ThemeSwitcherProps | Nextjs Themes

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    nonce?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? forcedTheme? nonce? styles? @@ -6,20 +6,20 @@ themeTransition?

Properties

OptionalforcedColorScheme

forcedColorScheme?: ColorSchemeType

Forced color scheme for the current page

See

Force per page theme and color-scheme

-

OptionalforcedTheme

forcedTheme?: string

Forced theme name for the current page

+

OptionalforcedTheme

forcedTheme?: string

Forced theme name for the current page

See

Force per page theme and color-scheme

-

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

-

Optionalstyles

styles?: Record<string, string>

Provide a styles object imported from CSS/SCSS modules if you are using these modules to define theme and color-scheme classes. +

Optionalnonce

nonce?: string

The nonce value for your Content Security Policy.

+

Optionalstyles

styles?: Record<string, string>

Provide a styles object imported from CSS/SCSS modules if you are using these modules to define theme and color-scheme classes. All classes applied to the target are modified using the styles object as follows: if (styles) classes = classes.map(cls => styles[cls] ?? cls);

-

OptionaltargetSelector

targetSelector?: string

CSS selector for the target element to apply the theme. +

OptionaltargetSelector

targetSelector?: string

CSS selector for the target element to apply the theme. Use this to specify a different target element than the default (html or documentElement). This is particularly useful for controlling the theme of different parts of the page independently.

-

OptionalthemeTransition

themeTransition?: string

The transition property to enforce on all elements, preventing unwanted transitions during theme changes.

+

OptionalthemeTransition

themeTransition?: string

The transition property to enforce on all elements, preventing unwanted transitions during theme changes.

Example

'background .3s'

Default Value

'none'
-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/hooks_use_theme.UseThemeYield.html b/docs/interfaces/hooks_use_theme.UseThemeYield.html index 0f90b83b..d6fe840c 100644 --- a/docs/interfaces/hooks_use_theme.UseThemeYield.html +++ b/docs/interfaces/hooks_use_theme.UseThemeYield.html @@ -1,4 +1,4 @@ -UseThemeYield | Nextjs Themes

Interface UseThemeYield

interface UseThemeYield {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    lightTheme: string;
    resolvedColorScheme: ResolvedColorSchemeType;
    resolvedTheme: string;
    setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void);
    setDarkTheme: ((darkTheme: string) => void);
    setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void);
    setForcedTheme: ((forcedTheme: string) => void);
    setLightTheme: ((lightTheme: string) => void);
    setTheme: ((theme: string) => void);
    setThemeSet: ((themeSet: {
        darkTheme: string;
        lightTheme: string;
    }) => void);
    systemColorScheme: ResolvedColorSchemeType;
    theme: string;
    toggleColorScheme: ((skipSystem?: boolean) => void);
}

Properties

colorSchemePref +UseThemeYield | Nextjs Themes

Interface UseThemeYield

interface UseThemeYield {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    lightTheme: string;
    resolvedColorScheme: ResolvedColorSchemeType;
    resolvedTheme: string;
    setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void);
    setDarkTheme: ((darkTheme: string) => void);
    setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void);
    setForcedTheme: ((forcedTheme: string) => void);
    setLightTheme: ((lightTheme: string) => void);
    setTheme: ((theme: string) => void);
    setThemeSet: ((themeSet: {
        darkTheme: string;
        lightTheme: string;
    }) => void);
    systemColorScheme: ResolvedColorSchemeType;
    theme: string;
    toggleColorScheme: ((skipSystem?: boolean) => void);
}

Properties

colorSchemePref darkTheme lightTheme resolvedColorScheme @@ -13,5 +13,5 @@ systemColorScheme theme toggleColorScheme -

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

lightTheme

lightTheme: string

resolvedColorScheme

resolvedColorScheme: ResolvedColorSchemeType

resolvedTheme

resolvedTheme: string

setColorSchemePref

setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void)

setDarkTheme

setDarkTheme: ((darkTheme: string) => void)

setForcedColorScheme

setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void)

setForcedTheme

setForcedTheme: ((forcedTheme: string) => void)

setLightTheme

setLightTheme: ((lightTheme: string) => void)

setTheme

setTheme: ((theme: string) => void)

actions

-

setThemeSet

setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)

systemColorScheme

systemColorScheme: ResolvedColorSchemeType

theme

theme: string

toggleColorScheme

toggleColorScheme: ((skipSystem?: boolean) => void)

Settings

Member Visibility

On This Page

Properties
+

Properties

colorSchemePref

colorSchemePref: ColorSchemeType

darkTheme

darkTheme: string

lightTheme

lightTheme: string

resolvedColorScheme

resolvedColorScheme: ResolvedColorSchemeType

resolvedTheme

resolvedTheme: string

setColorSchemePref

setColorSchemePref: ((colorSchemePref: ColorSchemeType) => void)

setDarkTheme

setDarkTheme: ((darkTheme: string) => void)

setForcedColorScheme

setForcedColorScheme: ((forcedColorScheme: ColorSchemeType) => void)

setForcedTheme

setForcedTheme: ((forcedTheme: string) => void)

setLightTheme

setLightTheme: ((lightTheme: string) => void)

setTheme

setTheme: ((theme: string) => void)

actions

+

setThemeSet

setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)

systemColorScheme

systemColorScheme: ResolvedColorSchemeType

theme

theme: string

toggleColorScheme

toggleColorScheme: ((skipSystem?: boolean) => void)

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 57a10e87..778dad88 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 | Nextjs Themes

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps +client/color-switch/color-switch | Nextjs Themes

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps

Functions

ColorSwitch

Settings

Member Visibility
diff --git a/docs/modules/client_force_color_scheme_force_color_scheme.html b/docs/modules/client_force_color_scheme_force_color_scheme.html index db522d0d..24bdee19 100644 --- a/docs/modules/client_force_color_scheme_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme/force-color-scheme | Nextjs Themes

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme +client/force-color-scheme/force-color-scheme | Nextjs Themes

Module client/force-color-scheme/force-color-scheme

Index

Functions

ForceColorScheme

Settings

Member Visibility
diff --git a/docs/modules/client_force_theme_force_theme.html b/docs/modules/client_force_theme_force_theme.html index b4991975..27bbcf86 100644 --- a/docs/modules/client_force_theme_force_theme.html +++ b/docs/modules/client_force_theme_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme/force-theme | Nextjs Themes

Module client/force-theme/force-theme

Index

Functions

ForceTheme +client/force-theme/force-theme | Nextjs Themes

Module client/force-theme/force-theme

Index

Functions

ForceTheme

Settings

Member Visibility
diff --git a/docs/modules/client_switcher_switcher.html b/docs/modules/client_switcher_switcher.html index a1ab90e4..dd98dc08 100644 --- a/docs/modules/client_switcher_switcher.html +++ b/docs/modules/client_switcher_switcher.html @@ -1,2 +1,2 @@ -client/switcher/switcher | Nextjs Themes

Module client/switcher/switcher

Index

Functions

Switcher +client/switcher/switcher | Nextjs Themes

Module client/switcher/switcher

Index

Functions

Switcher

Settings

Member Visibility
diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index 64c26f33..492dcc47 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 | Nextjs Themes

Module client/theme-switcher/theme-switcher

Index

Interfaces

ThemeSwitcherProps +client/theme-switcher/theme-switcher | Nextjs Themes

Module client/theme-switcher/theme-switcher

Index

Interfaces

ThemeSwitcherProps

Functions

ThemeSwitcher

Settings

Member Visibility
diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 69089258..43939eb1 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,3 +1,3 @@ -hooks/use-theme | Nextjs Themes

Module hooks/use-theme

Index

Interfaces

UseThemeYield +hooks/use-theme | Nextjs Themes

Module hooks/use-theme

Index

Interfaces

UseThemeYield

Functions

useTheme

Settings

Member Visibility
diff --git a/docs/modules/types.html b/docs/modules/types.html index 52d764f8..27dd0e0e 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1,3 +1,3 @@ -types | Nextjs Themes

Module types

Index

Type Aliases

ColorSchemeType +types | Nextjs Themes

Module types

Index

Type Aliases

ColorSchemeType ResolvedColorSchemeType

Settings

Member Visibility
diff --git a/docs/types/types.ColorSchemeType.html b/docs/types/types.ColorSchemeType.html index 7a8e8ca1..2e881fcd 100644 --- a/docs/types/types.ColorSchemeType.html +++ b/docs/types/types.ColorSchemeType.html @@ -1,2 +1,2 @@ ColorSchemeType | Nextjs Themes

Type Alias ColorSchemeType

ColorSchemeType:
    | ""
    | "system"
    | "dark"
    | "light"

Types to be exposed to users

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/types.ResolvedColorSchemeType.html b/docs/types/types.ResolvedColorSchemeType.html index 55afc567..0b64936d 100644 --- a/docs/types/types.ResolvedColorSchemeType.html +++ b/docs/types/types.ResolvedColorSchemeType.html @@ -1 +1 @@ -ResolvedColorSchemeType | Nextjs Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"

Settings

Member Visibility
+ResolvedColorSchemeType | Nextjs Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"

Settings

Member Visibility
diff --git a/examples/vite/package.json b/examples/vite/package.json index cf558031..dcb8174f 100644 --- a/examples/vite/package.json +++ b/examples/vite/package.json @@ -15,7 +15,7 @@ "nextjs-themes": "workspace:*", "react": "^18.3.1", "react-dom": "^18.3.1", - "react-router-dom": "^7.0.0" + "react-router-dom": "^7.0.1" }, "devDependencies": { "@repo/eslint-config": "workspace:*", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2180453a..ffb5834f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -260,8 +260,8 @@ importers: specifier: ^18.3.1 version: 18.3.1(react@18.3.1) react-router-dom: - specifier: ^7.0.0 - version: 7.0.0(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^7.0.1 + version: 7.0.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1) devDependencies: '@repo/eslint-config': specifier: workspace:* @@ -4204,15 +4204,15 @@ packages: resolution: {integrity: sha512-jCvmsr+1IUSMUyzOkRcvnVbX3ZYC6g9TDrDbFuFmRDq7PD4yaGbLKNQL6k2jnArV8hjYxh7hVhAZB6s9HDGpZA==} engines: {node: '>=0.10.0'} - react-router-dom@7.0.0: - resolution: {integrity: sha512-2QAxXpwgQuh423C64oZiV2cCKPCNUgZxcvZaS8O0PAHPZ/z8kTq7YbGD4KTNZm6Yj66d+HAfGkWPp8MCpdtD+Q==} + react-router-dom@7.0.1: + resolution: {integrity: sha512-duBzwAAiIabhFPZfDjcYpJ+f08TMbPMETgq254GWne2NW1ZwRHhZLj7tpSp8KGb7JvZzlLcjGUnqLxpZQVEPng==} engines: {node: '>=20.0.0'} peerDependencies: react: '>=18' react-dom: '>=18' - react-router@7.0.0: - resolution: {integrity: sha512-1xf+yMVhUjAzZGY90ZnYJ9KVe1R8FggpugzRBkh+p6vl4cC1sHDe3nO+r5rxWTAgCMf8uN5hfoV2M7rLVTWPUA==} + react-router@7.0.1: + resolution: {integrity: sha512-WVAhv9oWCNsja5AkK6KLpXJDSJCQizOIyOd4vvB/+eHGbYx5vkhcmcmwWjQ9yqkRClogi+xjEg9fNEOd5EX/tw==} engines: {node: '>=20.0.0'} peerDependencies: react: '>=18' @@ -9409,13 +9409,13 @@ snapshots: react-refresh@0.14.2: {} - react-router-dom@7.0.0(react-dom@18.3.1(react@18.3.1))(react@18.3.1): + react-router-dom@7.0.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1): dependencies: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) - react-router: 7.0.0(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + react-router: 7.0.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1) - react-router@7.0.0(react-dom@18.3.1(react@18.3.1))(react@18.3.1): + react-router@7.0.1(react-dom@18.3.1(react@18.3.1))(react@18.3.1): dependencies: '@types/cookie': 0.6.0 cookie: 1.0.2