🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →

Demo Install Sign in

react18-themes

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react18-themes

Unleash the Power of React Server Components! Use multiple themes on your site with confidence, without losing any advantages of React Server Components.

3.2.0

latest

Source

npm

Version published: 12 months ago

Weekly downloads: 2.1K

Maintainers: 0

Weekly downloads

Created: 2 years ago

Source

React 18 Themes

npm bundle size

Version 3 Short Notes:

Version 3.0 brings minor API changes along with major performance improvements and fixes. We have minimized changes to existing APIs.

Note: react18-themes will now be maintained as react18-themes, as server-specific APIs are no longer needed.

🤟 👉 Unleash the Power of React Server Components

✅ Perfect dark mode in 2 lines of code
✅ Fully Treeshakable (import from react18-themes/client/component)
✅ Full TypeScript Support
✅ Secure by design - we support nonce for scripts and styles
✅ Unleash the full power of React 18 Server components

Exampand following to see more features.

Motivation and Key Features:

This project was inspired by next-themes. Unlike next-themes, react18-themes doesn't require wrapping everything in a provider, allowing you to take full advantage of React 18 Server Components. Additionally, it offers more features and control over your app's theming.

✅ Perfect dark mode in 2 lines of code
✅ Fully Treeshakable (import from react18-themes/client/component)
✅ Designed for excellence
✅ Full TypeScript Support
✅ Unleash the full power of React 18 Server components
✅ System setting with prefers-color-scheme
✅ Themed browser UI with color-scheme
✅ Support for Next.js 13 & Next.js 14 appDir
✅ No flash on load (for all - SSG, SSR, ISG, Server Components)
✅ Sync theme across tabs and windows
✅ Disable flashing when changing themes
✅ Force pages to specific themes
✅ Class and data attribute selector
✅ Manipulate theme via useTheme hook
✅ Documented with Typedoc (Docs)
✅ Use combinations of [data-th=""] and [data-color-scheme=""] for dark/light variants of themes
✅ Use [data-csp=""] to style based on colorSchemePreference.

Check out the live example.

Installation

$ pnpm add react18-themes

$ npm install react18-themes

$ yarn add react18-themes

Want Lite Version?

$ pnpm add react18-themes-lite

$ npm install react18-themes-lite

$ yarn add react18-themes-lite

Note: r18gs is a peer dependency

Usage

SPA (e.g., Vite, CRA) and Next.js pages directory (No server components)

To add dark mode support, modify _app.js as follows:

import { ThemeSwitcher } from "react18-themes";

function MyApp({ Component, pageProps }) {
  return (
    <>
      <ThemeSwitcher forcedTheme={Component.theme} />
      <Component {...pageProps} />
    </>
  );
}

export default MyApp;

⚡🎉Boom! Dark mode is ready in just a couple of lines!

With Next.js `app` router (Server Components)

Update app/layout.jsx to add ThemeSwitcher from react18-themes:

// app/layout.jsx
import { ThemeSwitcher } from "react18-themes";

export default function Layout({ children }) {
  return (
    <html lang="en">
      <head />
      <body>
        <ThemeSwitcher />
        {children}
      </body>
    </html>
  );
}

Woohoo! Multiple theme modes with Server Components support!

HTML & CSS

Next.js app supports dark mode, including System preference with prefers-color-scheme. The theme is synced between tabs, modifying the data-theme attribute on the html element:

:root {
  --background: white;
  --foreground: black;
}

[data-theme="dark"] {
  --background: black;
  --foreground: white;
}

Images

Show different images based on the current theme:

import Image from "next/image";
import { useTheme } from "react18-themes";

function ThemedImage() {
  const { resolvedTheme } = useTheme();
  const src = resolvedTheme === "light" ? "/light.png" : "/dark.png";
  return <Image src={src} width={400} height={400} />;
}

export default ThemedImage;

useTheme

The useTheme hook provides theme information and allows changing the theme:

import { useTheme } from "react18-themes";

const ThemeChanger = () => {
  const { theme, setTheme } = useTheme();

  return (
    <div>
      The current theme is: {theme}
      <button onClick={() => setTheme("light")}>Light Mode</button>
      <button onClick={() => setTheme("dark")}>Dark Mode</button>
    </div>
  );
};

The useTheme hook returns the following object:

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

Force per page theme and color-scheme

Next.js App Router

import { ForceTheme } from "react18-themes";

function MyPage() {
  return (
    <>
      <ForceTheme theme="my-theme" />
      ...
    </>
  );
}

export default MyPage;

Next.js Pages Router

For the pages router, you have two options. The first option is the same as the app router, and the second option, which is compatible with next-themes, involves adding the theme property to your page component like this:

function MyPage() {
  return <>...</>;
}

MyPage.theme = "my-theme";

export default MyPage;

Similarly, you can force a color scheme. This will apply your defaultDark or defaultLight theme, which can be configured via hooks.

With Styled Components and any CSS-in-JS

Next Themes works with any library. For Styled Components, createGlobalStyle in your custom App:

// pages/_app.js
import { createGlobalStyle } from "styled-components";
import { ThemeSwitcher } from "react18-themes";

const GlobalStyle = createGlobalStyle`
  :root {
    --fg: #000;
    --bg: #fff;
  }

  [data-theme="dark"] {
    --fg: #fff;
    --bg: #000;
  }
`;

function MyApp({ Component, pageProps }) {
  return (
    <>
      <GlobalStyle />
      <ThemeSwitcher forcedTheme={Component.theme} />
      <Component {...pageProps} />
    </>
  );
}

With Tailwind

In tailwind.config.js, set the dark mode property to class:

// tailwind.config.js
module.exports = {
  darkMode: "class",
};

⚡🎉Ready to use dark mode in Tailwind!

Caution: Your class must be "dark", which is the default value used in this library. Tailwind requires the class name "dark" for dark-theme.

Use dark-mode specific classes:

<h1 className="text-black dark:text-white">

Migration

Refer to the migration guide.

Docs

Typedoc

🤩 Don't forget to star this repo!

Want a hands-on course for getting started with Turborepo? Check out React and Next.js with TypeScript

FAQ

Do I need to use CSS variables with this library?

No. You can hard code values for every class:

.my-class {
  color: #555;
}

[data-theme="dark"] .my-class {
  color: white;
}

Why is resolvedTheme and resolvedColorScheme necessary?

To reflect the System theme preference and forced theme/colorScheme pages in your UI. For instance, buttons or dropdowns indicating the current colorScheme should say "system" when the System colorScheme preference is active.

resolvedTheme is useful for modifying behavior or styles at runtime:

const { resolvedTheme, resolvedColorScheme } = useTheme();
const background = getBackground(resolvedTheme);

<div style={{ color: resolvedColorScheme === 'dark' ? white : black, background }}>

Without resolvedTheme, you would only know the theme is "system", not what it resolved to.

Repo stats

License

This library is licensed under the MPL-2.0 open-source license.

Please consider enrolling in our courses or sponsoring our work.

with 💖 by Mayank Kumar Chaudhari

Keywords

React server components

FAQs

What is react18-themes?

Is react18-themes popular?

Is react18-themes well maintained?

Package last updated on 23 Jun 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

react18-themes

React 18 Themes .css-11gvwjj{object-fit:cover;display:inline;}

Motivation and Key Features:

Installation

Want Lite Version?

Usage

SPA (e.g., Vite, CRA) and Next.js pages directory (No server components)

With Next.js app router (Server Components)

HTML & CSS

Images

useTheme

Force per page theme and color-scheme

Next.js App Router

Next.js Pages Router

With Styled Components and any CSS-in-JS

With Tailwind

Migration

Docs

🤩 Don't forget to star this repo!

FAQ

License

Keywords

Related posts

2025 Blockchain and Cryptocurrency Threat Report: Malware in the Open Source Supply Chain

pnpm 10.12 Introduces Global Virtual Store and Expanded Version Catalogs

React 18 Themes

With Next.js `app` router (Server Components)