https://github.com/abereghici/remix-themes
An abstraction for themes in your Remix app.
https://github.com/abereghici/remix-themes
dark-mode dark-theme javascript react remix remix-run theme themes typescript
Last synced: 30 days ago
JSON representation
An abstraction for themes in your Remix app.
- Host: GitHub
- URL: https://github.com/abereghici/remix-themes
- Owner: abereghici
- Created: 2021-12-18T14:41:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T16:46:52.000Z (5 months ago)
- Last Synced: 2025-04-16T17:59:42.799Z (about 2 months ago)
- Topics: dark-mode, dark-theme, javascript, react, remix, remix-run, theme, themes, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/remix-themes
- Size: 824 KB
- Stars: 148
- Watchers: 3
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-remix - remix-themes - An abstraction for themes in your Remix app. (Utility)
- awesome-remix - remix-themes - An abstraction for themes in your Remix app. (Utility)
README
# Remix Themes
### An abstraction for themes in your [React router](https://reactrouter.com/) / [Remix](https://remix.run/) app.
## Features
- ✅ Perfect dark mode in a few lines of code
- ✅ System setting with prefers-color-scheme
- ✅ No flash on load
- ✅ Disable flashing when changing themes
- ✅ Class or data attribute selector
- ✅ Sync theme across tabs and windows
Check out the
[Example](https://github.com/abereghici/remix-themes/tree/main/test-apps/react-router-app)
to see it in action.
If you are using Remix.run you can use v1.6.1 of this library or lower, v2 onwards is only react-router v7 compatible.
## Install
```bash
$ npm install remix-themes
# or
$ yarn add remix-themes
```
## Getting Started
### Create your session storage and create a themeSessionResolver
```ts
// sessions.server.tsx
import { createThemeSessionResolver } from "remix-themes";
import { createCookieSessionStorage } from "react-router";
const sessionStorage = createCookieSessionStorage({
cookie: {
name: "__remix-themes",
// domain: 'remix.run',
path: "/",
httpOnly: true,
sameSite: "lax",
secrets: ["s3cr3t"],
// secure: true,
},
});
export const themeSessionResolver = createThemeSessionResolver(sessionStorage);
```
Note: make sure you have `domain` and `secure` parameters set only for your
production environment. Otherwise, Safari won't store the cookie if you set
these parameters on localhost.
### Setup Remix Themes
```ts
// root.tsx
import {
ThemeProvider,
useTheme,
PreventFlashOnWrongTheme,
} from "remix-themes";
import { themeSessionResolver } from "./sessions.server";
// Return the theme from the session storage using the loader
export const loader: LoaderFunction = async ({ request }) => {
const { getTheme } = await themeSessionResolver(request);
return {
theme: getTheme(),
};
};
// Wrap your app with ThemeProvider.
// `specifiedTheme` is the stored theme in the session storage.
// `themeAction` is the action name that's used to change the theme in the session storage.
export default function AppWithProviders() {
const data = useLoaderData();
return (
);
}
// Use the theme in your app.
// If the theme is missing in session storage, PreventFlashOnWrongTheme will get
// the browser theme before hydration and will prevent a flash in browser.
// The client code runs conditionally, it won't be rendered if we have a theme in session storage.
function App() {
const data = useLoaderData();
const [theme] = useTheme();
return (
);
}
```
#### Add the action route
Create a file in `/routes/action/set-theme.ts` or `/routes/action.set-theme.ts`
when using
[Route File Naming v2](https://remix.run/docs/en/1.19.3/file-conventions/route-files-v2#route-file-naming-v2)
with the content below. Ensure that you pass the filename to the `ThemeProvider`
component.
> Note: You can name the action route whatever you want. Just make sure you pass
> the correct action name to the `ThemeProvider` component. Make sure to use
> absolute path when using nested routing.
This route is used to store the preferred theme in the session storage when
the user changes it.
```ts
import { createThemeAction } from "remix-themes";
import { themeSessionResolver } from "./sessions.server";
export const action = createThemeAction(themeSessionResolver);
```
## API
Let's dig into the details.
### ThemeProvider
- `specifiedTheme`: The theme from the session storage.
- `themeAction`: The action name used to change the theme in the session
storage.
- `disableTransitionOnThemeChange`: Disable CSS transitions on theme change to
prevent the flashing effect.
### useTheme
useTheme takes no parameters but returns:
- `theme`: Active theme name
- `setTheme`: Function to set the theme. If the theme is set to `null`, the
system theme will be used and `definedBy` property in the `metadata` object
will be set to `SYSTEM`.
- `metadata`: An object which contains the following properties:
- `definedBy`: The theme source. It can be `USER` or `SYSTEM`. Useful to
detect if the theme was set by the user or by the system.
### createThemeSessionResolver
`createThemeSessionResolver` function takes a cookie session storage and returns
- `resolver`: A function that takes a request and returns an object with the
following properties:
- `getTheme`: A function that returns the theme from the session storage.
- `setTheme`: A function that takes a theme name and sets it in the session
storage.
- `commit`: A function that commits the session storage (Stores all data in
the session and returns the Set-Cookie header to use in the HTTP response.)
### PreventFlashOnWrongTheme
On the server, "theme" might be `null` so `PreventFlashOnWrongTheme` ensures
that this is correct before hydration. If the theme is null on the server, this
component will set the browser theme on the `html` element in a `data-theme`
attribute if exists, otherwise it will be set to a `class` attribute. If both
`data-theme` and `class` are set, the `data-theme` will be used.
- `ssrTheme`: boolean value that indicates if we have a theme in the session
storage.