Nuxt Color Mode

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

🌑 Dark and 🌕 Light mode with auto detection made easy with Nuxt.


Live demo

- ✨  Release Notes
- 📖  Documentation
- ▶️  Online playground

Features

- Add .${color}-mode class to for easy CSS theming
- Force a page to a specific color mode (perfect for incremental development)
- Works with client-side and universal rendering
- Auto detect system color-mode

📖  Read more

Note: v3 of @nuxtjs/color-mode is compatible with Nuxt 3+ and Nuxt Bridge. If you're looking for the previous version of this module, check out the previous docs, or read more about the differences.

Contributing

You can contribute to this module online with CodeSandBox:


Or locally:

1. Clone this repository
2. Install dependencies using pnpm install
3. Start development server using pnpm dev

License

MIT License

Copyright (c) Nuxt Team

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/color-mode/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxtjs/color-mode

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/color-mode.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/color-mode

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/color-mode.svg?style=flat&colorA=18181B&colorB=28CF8D
[codecov-href]: https://codecov.io/gh/nuxt-modules/color-mode

[license-src]: https://img.shields.io/npm/l/@nuxtjs/color-mode.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxtjs/color-mode
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com