Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.49 KB

upgrading.md

File metadata and controls

70 lines (52 loc) · 2.49 KB
Raw

Table of contents

Upgrading to v3.0.0 from v2.x

Additionally to these changes, some features have been added, such as a built-in variant plugin. Make sure to read the new documentation to fully understand how to use the new configuration.

Plugin declaration

Previously, you had to directly import your configuration file. Now, you need to import the actual module, tailwindcss-theming. It will look for a theme.config.js at the root of your project. For more information, see how to change the theme file.

// tailwind.config.js

module.exports = {
  theme: {},
  variants: {},
  plugins: [
-    require('./theme.config.js')
+    require('tailwindcss-theming')
  ],
};

Import

A ThemeBuilder and a Theme object had to be imported from tailwindcss-theming. The new builder object is called ThemeManager, and you need to import it from tailwindcss-theming/api.

// theme.config.js

- const { ThemeBuilder, Theme } = require('tailwindcss-theming');
+ const { ThemeManager, Theme } = require('tailwindcss-theming/api');

Theme API changes

  • name() is now setName()
  • assignable() is now targetable()
  • colors() is now addColors() and supports Tailwind's nested color syntax
  • opacityVariant() is now setOpacityVariant()
  • colorVariant() is now setColorVariant()
  • variable() is now setVariable()

More informations about the new configuration on the themes documentation.

ThemeBuilder API changes

  • ThemeBuilder is now ThemeManager
  • ThemeBuilder is now ThemeManager
  • default is now setDefaultTheme
  • light() is has been removed
  • dark() is has been removed
  • setDefaultLightTheme() theme has been added
  • setDefaultDarkTheme() theme has been added
  • theme() is now addTheme()
  • addLightTheme() theme has been added
  • addDarkTheme() theme has been added
  • prefix() is now setPrefix()
  • asDataThemeAttribute() is now asDataThemeAttributes()
  • asDataAttribute() is now asDataAttributes()
  • asPrefixedAttribute() is now asPrefixedAttributes()
  • asClass() is now asClasses()
  • asPrefixedClass() is now asPrefixedClasses()

More informations about the new configuration on the themes documentation.