From 7ff14d02d01a0d8b7b72c1a1ed2481c7627ef10c Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Fri, 28 Jun 2024 16:05:16 +0000 Subject: [PATCH] upgrade deps && docs --- ...color_switch_color_switch.ColorSwitch.html | 2 +- ...e_force_color_scheme.ForceColorScheme.html | 2 +- ...nt_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 +- ..._switch_color_switch.ColorSwitchProps.html | 6 ++-- ...her_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 +- package.json | 2 +- pnpm-lock.yaml | 28 +++++++++---------- 20 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index df3b801d..5db7b4d4 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 />
 
-
\ No newline at end of file +
\ No newline at end of file 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 23812cda..f8984f0b 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

Force color scheme on a page

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/client_force_theme_force_theme.ForceTheme.html b/docs/functions/client_force_theme_force_theme.ForceTheme.html index ad0ad552..b76539c2 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

Force theme on a page

-
  • Parameters

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

    Returns null

\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/client_switcher_switcher.Switcher.html b/docs/functions/client_switcher_switcher.Switcher.html index b230c020..fda65ad5 100644 --- a/docs/functions/client_switcher_switcher.Switcher.html +++ b/docs/functions/client_switcher_switcher.Switcher.html @@ -3,4 +3,4 @@
<Switcher targetSelector="#container1" />
 
-
\ 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 88987a23..85531f59 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 @@
<ThemeSwitcher [...props] />
 
-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/hooks_use_theme.useTheme.html b/docs/functions/hooks_use_theme.useTheme.html index 765e36a4..d9fcaa66 100644 --- a/docs/functions/hooks_use_theme.useTheme.html +++ b/docs/functions/hooks_use_theme.useTheme.html @@ -1,4 +1,4 @@ useTheme | Nextjs Themes
const [] = useTheme(options);
 
-
\ 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 70bc7308..949613e3 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 {
    size?: number;
    skipSystem?: boolean;
    targetSelector?: string;
}

Hierarchy

Properties

size? +ColorSwitchProps | Nextjs Themes
interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetSelector?: string;
}

Hierarchy

Properties

size?: number

Diameter of the color switch

-
skipSystem?: boolean

Skip system colorScheme while toggling

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

Skip system colorScheme while toggling

+
targetSelector?: string
\ 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 0af77b5e..2c469eb7 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 {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    nonce?: string;
    styles?: Record<string, string>;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

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

Properties

forcedColorScheme?: ColorSchemeType

Forced color scheme for the current page

forcedTheme?: string

Forced theme name for the current page

+
forcedTheme?: string

Forced theme name for the current page

nonce?: string

The nonce value for your Content Security Policy.

-
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. +

nonce?: string

The nonce value for your Content Security Policy.

+
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);

-
targetSelector?: string

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

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.

-
themeTransition?: string

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

+
themeTransition?: string

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

'background .3s'
 
'none'
 
-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/hooks_use_theme.UseThemeYield.html b/docs/interfaces/hooks_use_theme.UseThemeYield.html index 63f5c5ab..4caa4cce 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 {
    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 {
    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: 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)

actions

-
setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)
systemColorScheme: ResolvedColorSchemeType
theme: string
toggleColorScheme: ((skipSystem?: boolean) => void)
\ No newline at end of file +

Properties

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)

actions

+
setThemeSet: ((themeSet: {
    darkTheme: string;
    lightTheme: string;
}) => void)
systemColorScheme: ResolvedColorSchemeType
theme: string
toggleColorScheme: ((skipSystem?: boolean) => void)
\ 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 66cfbd23..c59590e8 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

Functions

\ No newline at end of file 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 2956c6c3..2d952b88 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
\ No newline at end of file diff --git a/docs/modules/client_force_theme_force_theme.html b/docs/modules/client_force_theme_force_theme.html index 3bd0da2b..9e8d53d0 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

\ No newline at end of file diff --git a/docs/modules/client_switcher_switcher.html b/docs/modules/client_switcher_switcher.html index 7c1dfa41..0589f4e3 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

\ 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 42f337f5..db96caea 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
\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 48e42665..813aba75 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

Functions

\ No newline at end of file diff --git a/docs/modules/types.html b/docs/modules/types.html index cef029c4..07aadf94 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
\ No newline at end of file diff --git a/docs/types/types.ColorSchemeType.html b/docs/types/types.ColorSchemeType.html index 9add4119..17f87346 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

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/types/types.ResolvedColorSchemeType.html b/docs/types/types.ResolvedColorSchemeType.html index d35f6467..0a1a9922 100644 --- a/docs/types/types.ResolvedColorSchemeType.html +++ b/docs/types/types.ResolvedColorSchemeType.html @@ -1 +1 @@ -ResolvedColorSchemeType | Nextjs Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"
\ No newline at end of file +ResolvedColorSchemeType | Nextjs Themes

Type Alias ResolvedColorSchemeType

ResolvedColorSchemeType: "dark" | "light"
\ No newline at end of file diff --git a/package.json b/package.json index 51f3def9..71baad25 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "prettier": "^3.3.2", "turbo": "^2.0.5", "typedoc": "^0.26.3", - "typedoc-plugin-extras": "^3.0.0", + "typedoc-plugin-extras": "^3.1.0", "typedoc-plugin-mdn-links": "^3.2.1", "typedoc-plugin-missing-exports": "^3.0.0", "typedoc-plugin-rename-defaults": "^0.7.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bcab2172..2663a2f4 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -37,8 +37,8 @@ importers: specifier: ^0.26.3 version: 0.26.3(typescript@5.5.2) typedoc-plugin-extras: - specifier: ^3.0.0 - version: 3.0.0(typedoc@0.26.3(typescript@5.5.2)) + specifier: ^3.1.0 + version: 3.1.0(typedoc@0.26.3(typescript@5.5.2)) typedoc-plugin-mdn-links: specifier: ^3.2.1 version: 3.2.1(typedoc@0.26.3(typescript@5.5.2)) @@ -1043,8 +1043,8 @@ packages: '@rushstack/eslint-patch@1.10.3': resolution: {integrity: sha512-qC/xYId4NMebE6w/V33Fh9gWxLgURiNYgVNObbJl2LZv0GUUItCcCqC5axQSwRaAgaxl2mELq1rMzlswaQ0Zxg==} - '@shikijs/core@1.9.1': - resolution: {integrity: sha512-EmUful2MQtY8KgCF1OkBtOuMcvaZEvmdubhW0UHCGXi21O9dRLeADVCj+k6ZS+de7Mz9d2qixOXJ+GLhcK3pXg==} + '@shikijs/core@1.10.0': + resolution: {integrity: sha512-BZcr6FCmPfP6TXaekvujZcnkFmJHZ/Yglu97r/9VjzVndQA56/F4WjUKtJRQUnK59Wi7p/UTAOekMfCJv7jnYg==} '@sinclair/typebox@0.27.8': resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==} @@ -3940,8 +3940,8 @@ packages: resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} engines: {node: '>=8'} - shiki@1.9.1: - resolution: {integrity: sha512-8PDkgb5ja3nfujTjvC4VytL6wGOGCtFAClUb2r3QROevYXxcq+/shVJK5s6gy0HZnjaJgFxd6BpPqpRfqne5rA==} + shiki@1.10.0: + resolution: {integrity: sha512-YD2sXQ+TMD/F9BimV9Jn0wj35pqOvywvOG/3PB6hGHyGKlM7TJ9tyJ02jOb2kF8F0HfJwKNYrh3sW7jEcuRlXA==} side-channel@1.0.6: resolution: {integrity: sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==} @@ -4347,10 +4347,10 @@ packages: typedarray@0.0.6: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} - typedoc-plugin-extras@3.0.0: - resolution: {integrity: sha512-eiAe3qtm2WbV5owdncpt0zHZPqsNZH2mzNGILPd4zqrvEZie3Et9es4cpGZ+8lHO/SI0pVKwsAj7IuMxPNOdYg==} + typedoc-plugin-extras@3.1.0: + resolution: {integrity: sha512-8tNeq2fgl2HCUZ6eZuAoLLKEvB/WrRS4He9MtTfo3X3Pa8Iw3TS5D0g8krDhUXUk1uHpXVAVHm8rSOMS2mdJRw==} peerDependencies: - typedoc: 0.25.x + typedoc: 0.26.x typedoc-plugin-mdn-links@3.2.1: resolution: {integrity: sha512-l76VJKKhOxCYXnb16aV6nAQG5JCsuStqviNFmgzhS9dW73nqm3/1MO9497+0KlDTOPO3o+R2uVXq87d2cDy/hg==} @@ -5326,7 +5326,7 @@ snapshots: '@rushstack/eslint-patch@1.10.3': {} - '@shikijs/core@1.9.1': {} + '@shikijs/core@1.10.0': {} '@sinclair/typebox@0.27.8': {} @@ -8821,9 +8821,9 @@ snapshots: shebang-regex@3.0.0: {} - shiki@1.9.1: + shiki@1.10.0: dependencies: - '@shikijs/core': 1.9.1 + '@shikijs/core': 1.10.0 side-channel@1.0.6: dependencies: @@ -9247,7 +9247,7 @@ snapshots: typedarray@0.0.6: {} - typedoc-plugin-extras@3.0.0(typedoc@0.26.3(typescript@5.5.2)): + typedoc-plugin-extras@3.1.0(typedoc@0.26.3(typescript@5.5.2)): dependencies: typedoc: 0.26.3(typescript@5.5.2) @@ -9273,7 +9273,7 @@ snapshots: lunr: 2.3.9 markdown-it: 14.1.0 minimatch: 9.0.5 - shiki: 1.9.1 + shiki: 1.10.0 typescript: 5.5.2 yaml: 2.4.5