@hperchec/tailwindcss-multi-theme

v1.0.5

Published

a year ago

The easiest way to create themes with Tailwind CSS.

Downloads

0High
0Medium
0Low

herveperchec

tailwind theme dark multi

Tailwind CSS Multi Theme

This project is a fork of estevanmaito/tailwindcss-multi-theme.

Please read the docs of the parent repository.

WARNING: this plugin is designed for Tailwind v2!

Additional features

Based on the original version of estevanmaito/tailwindcss-multi-theme plugin, this following has been added:

migrate to [email protected]
plugin now accepts options
support for special characters in theme name

💿 Install

npm install tailwindcss-multi-theme

In tailwind.config.js add themeVariants to the theme property, with the value(s) of your theme(s), and require the plugin. That's it.

// tailwind.config.js
const multiThemePlugin = require('tailwindcss-multi-theme')

module.exports = {
  // Disable dark mode -> theme management is provided by multi-theme plugin
  darkMode: false,
  theme: {
    themeVariants: [
      // Define themes here
      'light',
      'dark',
      'banana'
    ]
  },
  variants: {
    // just add 'light', 'dark' and 'banana' to any variant that you want to style
  },
  plugins: [
    // Multi-theme plugin
    multiThemePlugin(),
    // ...
  ]
}

It will create a set of classes based on your variants and expect a class .theme-<the name of your themeVariants> at the top of your HTML document.

themeVariants: ['dark'] would activate its classes under .theme-dark.

🚀 Usage

Options

Example:

// tailwind.config.js
plugins: [
  multiThemePlugin({
    /**
     * Overwrite default theme class name themeClassPrefix
     * It will generate:
     * - 'light' class instead of 'theme-light'
     * - 'dark' class instead of 'theme-dark'
     * - 'banana' class instead of 'theme-banana'
     * - ...
     */
    themeClassPrefix: ''
  }),
  // ...
],

Theme names

You can use special characters in your theme names (see also CSS specification or this topic).

Example:

Here, we add @ prefix to the theme names to easily identify theme in class names:

// tailwind.config.js
const multiThemePlugin = require('tailwindcss-multi-theme')

module.exports = {
  // Disable dark mode -> theme management is provided by multi-theme plugin
  darkMode: false,
  theme: {
    themeVariants: [
      // Define themes here
      '@light',
      '@dark',
      '@banana'
    ],
    // Theme colors
    colors: {
      white:                  '#FFFFFF',
      black:                  '#000000',
      '@light-alabaster':     '#FAFAFA',
      '@dark-tuna':           '#36393F',
      '@banana-sandy-yellow': '#FFEA78',
      // and other theme colors...
    },
  },
  variants: {
    extend: {
      backgroundColor: [
        '@light',
        '@light:hover',
        '@light:focus',
        '@dark',
        '@dark:hover',
        '@dark:focus'
      ],
      // ...
    }
  },
  plugins: [
    // Multi-theme plugin
    multiThemePlugin({
      themeClassPrefix: ''
    }),
    // ...
  ]
}

In this example, it will generate:

class names: @light, @dark, @banana (e.g. set attribute class="@light" to the <html> element to apply light theme)
tailwind variants: @light, @dark, @banana (e.g. set class @dark:hover:bg-red to apply a red background on hover for dark theme)

Good practices

It's suggested to define your theme colors in a separated file (for example ./themes.js in your project):

TIP: you can use a tool like color-name-finder to name your colors correctly

// Example: themes.js

const commonColors = {
  // primary, secondary, etc... should be the same for all themes
  "primary": "#3B68CF",
  "secondary": "#36393F",
  // ...
}

module.exports = {
  themes: {
    // 'light' theme specific colors
    'light': {
      ...commonColors,
      'alabaster': '#FAFAFA',
      'text-primary': '#191919'
    },
    // 'dark' theme specific colors
    'dark': {
      ...commonColors,
      'tuna': '#36393F',
      'text-primary': '#F9F9F9'
    },
    // 'banana' theme specific colors
    'banana': {
      ...commonColors,
      'sandy-yellow': '#FFEA78',
      'text-primary': '#121212'
    }
  }
}

Then you can dynamically set in tailwind.config.js:

// Example: tailwind.config.js
const multiThemePlugin = require('tailwindcss-multi-theme')
const themes = require('./themes.js')

module.exports = {
  darkMode: false,
  theme: {
    themeVariants: [
      /**
       * It will generate theme names:
       * - '@light'
       * - '@dark'
       * - '@banana'
       */
      ...Object.keys(themes).map((theme) => {
        return `@${theme}`
      })
    ],
    colors: {
      /**
       * It will generate colors:
       * - '@light-primary'
       * - '@light-secondary'
       * - '@light-alabaster'
       * - '@light-text-primary'
       * - '@dark-primary'
       * - '@dark-secondary'
       * - '@dark-tuna'
       * - '@dark-text-primary'
       * - '@banana-primary'
       * - '@banana-secondary'
       * - '@banana-sandy-yellow'
       * - '@banana-text-primary'
       */
      ...Object.keys(themes).reduce((colors, themeName) => {
        // Loop on theme colors
        for (const color in themes[themeName]) {
          const colorName = `@${themeName}-${color}`
          const colorValue = themes[themeName][color]
          obj[colorName] = colorValue
        }
        return obj
      }, {})
    },
  },
  plugins: [
    // Multi-theme plugin
    multiThemePlugin({
      themeClassPrefix: ''
    }),
    // ...
  ],
  //...
}

So, you can use the generated theme colors:

<!-- 
  Example: apply a background color and a text color to the <body> element
  depending on what theme is applied
-->
<body
  class="
    @light:bg-@light-alabaster
    @light:text-@light-text-primary
    @dark:bg-@dark-tuna
    @dark:text-@dark-text-primary
    @banana:bg-@banana-sandy-yellow
    @banana:text-@banana-text-primary
  "
>
  ...
</body>

OR (in style):

body {
  // 'light' theme rules
  @apply @light:bg-@light-alabaster;
  @apply @light:text-@light-text-primary;
  // 'dark' theme rules
  @apply @dark:bg-@dark-tuna;
  @apply @dark:text-@dark-text-primary;
  // 'banana' theme rules
  @apply @banana:bg-@banana-sandy-yellow;
  @apply @banana:text-@banana-text-primary;
}

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme