tailwind-easy-theme-switcher

1.1.1 • Public • Published

Tailwind-Easy-Theme-Switcher

https://www.npmjs.com/package/tailwind-easy-theme-switcher

A lightweight library for dark/light mode switching that integrates with a Tailwind / React / Typescript workflow.

Demo

Theme Toggler GIF

Light Mode

Dark Mode

Usage

If you're using NPM:

npm install tailwind-easy-theme-switcher

import ThemeToggle from 'tailwind-easy-theme-switcher';

function App() {
  return (
    <div className="App">
      <h1>Theme Mode Toggle Example</h1>
      <ThemeToggle />
    </div>
  );
}

export default App;

E.g - when using tailwind, defaults are:

<div class = "dark:stroke-white stroke-black" >

If not using NPM, just stick the source code in a file and see the note below.

Important Note

For this to work you have to update your tailwind.config.ts - just slide this in before the "theme: " key

darkMode: 'class',

Next.js Users

Don't forget to put ```'use client'```` at the top of the file in which you import the theme switcher!

Props

The ThemeToggle component accepts the following props:

initialDarkMode: (optional) Specifies the initial state of the dark mode toggle. Default is false.
storageKey: (optional) Specifies the key to use for storing the dark mode state in local storage. Default is 'darkMode'.

License

This project is licensed under the MIT License.

Package Sidebar

Install

npm i tailwind-easy-theme-switcher

Weekly Downloads

1

Version

1.1.1

License

ISC

Unpacked Size

47.1 kB

Total Files

4

Last publish

Collaborators

  • jjb9922