Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blazity/nextjs-color-mode
⚡️ A helper for creating non-flickering and accessible themed applications
https://github.com/blazity/nextjs-color-mode
next next-plugin nextjs react server-side-rendering ssr static-site
Last synced: about 17 hours ago
JSON representation
⚡️ A helper for creating non-flickering and accessible themed applications
- Host: GitHub
- URL: https://github.com/blazity/nextjs-color-mode
- Owner: Blazity
- Created: 2021-08-18T11:50:10.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T23:12:06.000Z (7 months ago)
- Last Synced: 2024-04-22T13:54:17.551Z (7 months ago)
- Topics: next, next-plugin, nextjs, react, server-side-rendering, ssr, static-site
- Language: TypeScript
- Homepage: https://nextjs-color-mode.vercel.app/
- Size: 363 KB
- Stars: 23
- Watchers: 5
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Next.js color-mode
A helper for creating non-flickering and accessible themed applications
## Features
- [x] 🙉 Non-flickering
- [x] ♿ Accessible (supports `prefers-color-scheme`)
- [x] 🐱 Dynamic theme values
- [x] 🐄 No additional dependencies
- [x] 🧠 Agnostic to the way you style your app
## Installation
```
$ npm i --save nextjs-color-mode
# or
$ yarn add nextjs-color-mode
```
## Setup
First, you need to import `ColorModeScript` from `nextjs-color-mode` and place it somewhere in the `_app.js` file.
> If you're using styled-components or emotion, you can put the contents of `criticalThemeCss` to GlobalStyles. Just make sure it's critical css, and at the top of your global styles.
```jsx
// _app.js
import Head from 'next/head'
import { ColorModeScript } from 'nextjs-color-mode'
const criticalThemeCss = `
.next-light-theme {
--background: #fff;
--text: #000;
}
.next-dark-theme {
--background: #000;
--text: #fff;
}
body {
background: var(--background);
color: var(--text);
}
`
function MyApp({ Component, pageProps }) {
return (
<>
>
)
}
```
## Theme switcher (`useColorSwitcher`)
To implement theme switcher, you should use the `useColorSwitcher` hook
> Note that every component that explicitly uses this hook should be rendered only on the client-side. [Check out how we do this in the example](https://github.com/bmstefanski/next-color-mode/blob/master/example/pages/index.js#L5)
```jsx
import { ColorModeStyles, useColorModeValue, useColorSwitcher } from 'nextjs-color-mode'
export default function ColorSwitcher(props) {
const { toggleTheme, colorMode } = useColorSwitcher()
return (
Change theme to {colorMode === 'light' ? 'dark' : 'light'}
)
}
```
```tsx
function useColorSwitcher(): {
colorMode: string;
changeTheme: (colorMode: 'light' | 'dark') => void;
toggleTheme: () => void;
};
```
## Using dynamic variables (`useColorModeValue`)
Sometimes you may want to omit the design system or need to hotfix something fast. Here's the solution for that.
```jsx
export default function SomeComponent() {
const [boxBgColor, boxBgCss] = useColorModeValue('box-color', 'blue', 'red')
const [boxBorderColor, boxBorderCss] = useColorModeValue('box-border-color', 'red', 'blue')
// the first item of the array returns CSS variable name
// and the second one returns a special object that then gets parsed into a themable CSS variable
return (
<>
>
)
}
```
```tsx
function useColorModeValue(name: string, lightThemeValue: string, darkThemeValue: string);
```
> Do not use the same name twice, it may cause variable overriding and is hard to debug.
Also using things like unique id, UUID or any randomly generated set of characters is a bad idea - it will display mismatch content warning and make it even harder to debug!
## Support
If you're looking for help or simply want to share your thoughts about the project, we encourage you to join our Discord community. Here's the link: [https://blazity.com/discord](https://blazity.com/discord). It's a space where we exchange ideas and help one another. Everyone's input is appreciated, and we look forward to welcoming you.