tailwind-merge 0.8.1 → 1.1.0

package/README.md

@@ -1,7 +1,7 @@
 <div align="center">
     <br />
     <a href="https://github.com/dcastil/tailwind-merge">
-        <!-- AUTOGENERATED START logo-image --><img src="https://github.com/dcastil/tailwind-merge/raw/v0.8.1/assets/logo.svg" alt="tailwind-merge" width="221px" /><!-- AUTOGENERATED END -->
+        <!-- AUTOGENERATED START logo-image --><img src="https://github.com/dcastil/tailwind-merge/raw/v1.1.0/assets/logo.svg" alt="tailwind-merge" width="221px" /><!-- AUTOGENERATED END -->
     </a>
 </div>
 
@@ -16,16 +16,10 @@ twMerge('px-2 py-1 bg-red hover:bg-dark-red', 'p-3 bg-[#B91C1C]')
 // → 'hover:bg-dark-red p-3 bg-[#B91C1C]'
 ```
 
--   Supports Tailwind v2.0 up to v2.2, support for newer versions will be added continuously
+-   Supports Tailwind v3.0 (if you use Tailwind v2, use [tailwind-merge v0.9.0](https://github.com/dcastil/tailwind-merge/tree/v0.9.0))
 -   Works in Node >=12 and all modern browsers
 -   Fully typed
--   [<!-- AUTOGENERATED START package-gzip-size -->4.8 kB<!-- AUTOGENERATED END --> minified + gzipped](https://bundlephobia.com/package/tailwind-merge) (<!-- AUTOGENERATED START package-composition -->96.5% self, 3.5% hashlru<!-- AUTOGENERATED END -->)
-
-## Early development
-
-This library is in an early pre-v1 development stage and might have some bugs and inconveniences here and there. I use the library in production and intend it to be sufficient for production use, as long as you're fine with some potential breaking changes in minor releases until v1 (lock the version range to patch releases with `~` in your `package.json` to prevent accidental breaking changes).
-
-I want to keep the library on v0 until I feel confident enough that there aren't any major bugs or flaws in its API and implementation. If you find a bug or something you don't like, please [submit an issue](https://github.com/dcastil/tailwind-merge/issues/new) or a pull request. I'm happy about any kind of feedback!
+-   [Check bundle size on Bundlephobia](https://bundlephobia.com/package/tailwind-merge)
 
 ## What is it for
 
@@ -100,13 +94,26 @@ twMerge('hover:p-2 hover:p-4') // → 'hover:p-4'
 twMerge('hover:focus:p-2 focus:hover:p-4') // → 'focus:hover:p-4'
 ```
 
-### Supports custom values
+### Supports arbitrary values
 
 ```ts
 twMerge('bg-black bg-[color:var(--mystery-var)]') // → 'bg-[color:var(--mystery-var)]'
 twMerge('grid-cols-[1fr,auto] grid-cols-2') // → 'grid-cols-2'
 ```
 
+### Supports arbitrary properties
+
+```ts
+twMerge('[mask-type:luminance] [mask-type:alpha]') // → '[mask-type:alpha]'
+twMerge('[--scroll-offset:56px] lg:[--scroll-offset:44px]')
+// → '[--scroll-offset:56px] lg:[--scroll-offset:44px]'
+
+// Don't do this!
+twMerge('[padding:1rem] p-8') // → '[padding:1rem] p-8'
+```
+
+Watch out for mixing arbitrary properties which could be expressed as Tailwind classes. tailwind-merge does not resolve conflicts between arbitrary properties and their matching Tailwind classes to keep the bundle size small.
+
 ### Supports important modifier
 
 ```ts
@@ -132,6 +139,207 @@ twMerge('text-red text-secret-sauce') // → 'text-secret-sauce'
 twMerge('some-class', undefined, null, false) // → 'some-class'
 ```
 
+## Basic usage
+
+If you're using Tailwind CSS without any extra config, you can use [`twMerge`](#twmerge) right away. You can safely stop reading the documentation here.
+
+## Usage with custom Tailwind config
+
+If you're using a custom Tailwind config, you may need to configure tailwind-merge as well to merge classes properly.
+
+The default [`twMerge`](#twmerge) function is configured in a way that you can still use it if all of the following points apply to your Tailwind config:
+
+-   Only using color names which don't clash with other Tailwind class names
+-   Only deviating by number values from number-based Tailwind classes
+-   Only using font-family classes which don't clash with default font-weight classes
+-   Sticking to default Tailwind config for everything else
+
+If some of these points don't apply to you, you can test whether `twMerge` still works as intended with your custom classes. Otherwise you need create your own custom merge function by either extending the default tailwind-merge config or using a completely custom one.
+
+The tailwind-merge config is different from the Tailwind config because it's expected to be shipped and run in the browser as opposed to the Tailwind config which is meant to run at build-time. Be careful in case you're using your Tailwind config directly to configure tailwind-merge in your client-side code because that could result in an unnecessarily large bundle size.
+
+### Shape of tailwind-merge config
+
+The tailwind-merge config is an object with a few keys.
+
+```ts
+const tailwindMergeConfig = {
+    // ↓ Set how many values should be stored in cache.
+    cacheSize: 500,
+    theme: {
+        // Theme scales are defined here
+    },
+    classGroups: {
+        // Class groups are defined here
+    },
+    conflictingClassGroups: {
+        // Conflcits between class groups are defined here
+    },
+}
+```
+
+### Class groups
+
+The library uses a concept of _class groups_ which is an array of Tailwind classes which all modify the same CSS property. E.g. here is the position class group.
+
+```ts
+const positionClassGroup = ['static', 'fixed', 'absolute', 'relative', 'sticky']
+```
+
+tailwind-merge resolves conflicts between classes in a class group and only keeps the last one passed to the merge function call.
+
+```ts
+twMerge('static sticky relative') // → 'relative'
+```
+
+Tailwind classes often share the beginning of the class name, so elements in a class group can also be an object with values of the same shape as a class group (yes, the shape is recursive). In the object each key is joined with all the elements in the corresponding array with a dash (`-`) in between.
+
+E.g. here is the overflow class group which results in the classes `overflow-auto`, `overflow-hidden`, `overflow-visible` and `overflow-scroll`.
+
+```ts
+const overflowClassGroup = [{ overflow: ['auto', 'hidden', 'visible', 'scroll'] }]
+```
+
+Sometimes it isn't possible to enumerate all elements in a class group. Think of a Tailwind class which allows arbitrary values. In this scenario you can use a validator function which takes a _class part_ and returns a boolean indicating whether a class is part of a class group.
+
+E.g. here is the fill class group.
+
+```ts
+const isArbitraryValue = (classPart: string) => /^\[.+\]$/.test(classPart)
+const fillClassGroup = [{ fill: ['current', isArbitraryValue] }]
+```
+
+Because the function is under the `fill` key, it will only get called for classes which start with `fill-`. Also, the function only gets passed the part of the class name which comes after `fill-`, this way you can use the same function in multiple class groups. tailwind-merge exports its own [validators](#validators), so you don't need to recreate them.
+
+You can use am empty string (`''`) as a class part if you want to indicate that the preceding part was the end. This is useful for defining elements which are marked as `DEFAULT` in the Tailwind config.
+
+```ts
+// ↓ Resolves to filter and filter-none
+const filterClassGroup = [{ filter: ['', 'none'] }]
+```
+
+Each class group is defined under its ID in the `classGroups` object in the config. This ID is only used internally and the only thing that matters is that it is unique among all class groups.
+
+### Conflicting class groups
+
+Sometimes there are conflicts across Tailwind classes which are more complex than "remove all those other classes when a class from this group is present in the class list string".
+
+One example is the combination of the classes `px-3` (setting `padding-left` and `padding-right`) and `pr-4` (setting `padding-right`).
+
+If they are passed to `twMerge` as `pr-4 px-3`, I think you most likely intend to apply `padding-left` and `padding-right` from the `px-3` class and want `pr-4` to be removed, indicating that both these classes should belong to a single class group.
+
+But if they are passed to `twMerge` as `px-3 pr-4`, I assume you want to set the `padding-right` from `pr-4` but still want to apply the `padding-left` from `px-3`, so `px-3` shouldn't be removed when inserting the classes in this order, indicating they shouldn't be in the same class group.
+
+To summarize, `px-3` should stand in conflict with `pr-4`, but `pr-4` should not stand in conflict with `px-3`. to achieve this we need to define asymetric conflicts across class groups.
+
+This is what the `conflictingClassGroups` object in the tailwind-merge config is for. You define a key in it which is the ID of a class group which _creates_ a conflict and the value is an array of IDs of class group which _receive_ a conflict.
+
+```ts
+const conflictingClassGroups = {
+    px: ['pr', 'pl'],
+}
+```
+
+If a class group _creates_ a conflict, it means that if it appears in a class list string passed to `twMerge`, all preceding class groups in the string which _rceive_ the conflict will be removed.
+
+When we think of our example, the `px` class group creates a conflict which is received by the class groups `pr` and `pl`. This way `px-3` removes a preceding `pr-4`, but not the other way around.
+
+### Theme
+
+In the Tailwind config you can modify theme scales. tailwind-merge follows the same keys for the theme scales, but doesn't support all of them. tailwind-merge only supports theme scales which are used in multiple class groups to save bundle size (more info to that in [PR 55](https://github.com/dcastil/tailwind-merge/pull/55)). At the moment these are:
+
+-   `colors`
+-   `spacing`
+-   `blur`
+-   `brightness`
+-   `borderColor`
+-   `borderRadius`
+-   `borderWidth`
+-   `contrast`
+-   `grayscale`
+-   `hueRotate`
+-   `invert`
+-   `gap`
+-   `gradientColorStops`
+-   `inset`
+-   `margin`
+-   `opacity`
+-   `padding`
+-   `saturate`
+-   `scale`
+-   `sepia`
+-   `skew`
+-   `space`
+-   `translate`
+
+If you modified one of these theme scales in your Tailwind config, you can add all your keys right here and tailwind-merge will take care of the rest. If you modified other theme scales, you need to figure out the class group to modify in the [default config](#getdefaultconfig).
+
+### Extending the tailwind-merge config
+
+If you only need to extend the default tailwind-merge config, [`extendTailwindMerge`](#extendtailwindmerge) is the easiest way to extend the config. You provide it a `configExtension` object which gets [merged](#mergeconfigs) with the default config. Therefore all keys here are optional.
+
+```ts
+import { extendTailwindMerge } from 'tailwind-merge'
+
+const customTwMerge = extendTailwindMerge({
+    // ↓ Add values to existing theme scale or create a new one
+    theme: {
+        spacing: ['sm', 'md', 'lg'],
+    },
+    // ↓ Add values to existing class groups or define new ones
+    classGroups: {
+        foo: ['foo', 'foo-2', { 'bar-baz': ['', '1', '2'] }],
+        bar: [{ qux: ['auto', (value) => Number(value) >= 1000] }],
+    },
+    // ↓ Here you can define additional conflicts across class groups
+    conflictingClassGroups: {
+        foo: ['bar'],
+    },
+})
+```
+
+### Using completely custom tailwind-merge config
+
+If you need to modify the tailwind-merge config and need more control than [`extendTailwindMerge`](#extendtailwindmerge) gives you or don't want to use the default config (and tree-shake it out of your bundle), you can use [`createTailwindMerge`](#createtailwindmerge).
+
+The function takes a callback which returns the config you want to use and returns a custom `twMerge` function.
+
+```ts
+import { createTailwindMerge } from 'tailwind-merge'
+
+const customTwMerge = createTailwindMerge(() => ({
+    theme: {},
+    classGroups: {
+        foo: ['foo', 'foo-2', { 'bar-baz': ['', '1', '2'] }],
+        bar: [{ qux: ['auto', (value) => Number(value) >= 1000] }],
+    },
+    conflictingClassGroups: {
+        foo: ['bar'],
+    },
+}))
+```
+
+The callback passed to `createTailwindMerge` will be called when `customTwMerge` is called the first time, so you don't need to worry about the computations in it affecting app startup performance in case you aren't using tailwind-merge at app startup.
+
+### Using third-party tailwind-merge plugins
+
+You can use both [`extendTailwindMerge`](#extendtailwindmerge) and [`createTailwindMerge`](#createtailwindmerge) with third-party plugins. Just add them as arguments after your config.
+
+```ts
+import { extendTailwindMerge, createTailwindMerge } from 'tailwind-merge'
+import { withMagic } from 'tailwind-merge-magic-plugin'
+import { withMoreMagic } from 'tailwind-merge-more-magic-plugin'
+
+// With your own config
+const twMerge1 = extendTailwindMerge({ … }, withMagic, withMoreMagic)
+
+// Only using plugin with default config
+const twMerge2 = extendTailwindMerge(withMagic, withMoreMagic)
+
+// Using `createTailwindMerge`
+const twMerge3 = createTailwindMerge(() => ({  … }), withMagic, withMoreMagic)
+```
+
 ## API reference
 
 Reference to all exports of tailwind-merge.
@@ -142,14 +350,9 @@ Reference to all exports of tailwind-merge.
 function twMerge(...classLists: Array<string | undefined | null | false>): string
 ```
 
-Default function to use if you're using the default Tailwind config or are close enough to the default config. You can use this function if all of the following points apply to your Tailwind config:
-
--   Only using color names which don't clash with other Tailwind class names
--   Only deviating by number values from number-based Tailwind classes
--   Only using font-family classes which don't clash with default font-weight classes
--   Sticking to default Tailwind config for everything else
+Default function to use if you're using the default Tailwind config or are close enough to the default config. Check out [basic usage](#basic-usage) for more info.
 
-If some of these points don't apply to you, it makes sense to test whether `twMerge` still works as intended with your custom classes. Otherwise, you can create your own custom merge function with [`extendTailwindMerge`](#extendtailwindmerge).
+If `twMerge` doesn't work for you, you can create your own custom merge function with [`extendTailwindMerge`](#extendtailwindmerge).
 
 ### `getDefaultConfig`
 
@@ -159,6 +362,30 @@ function getDefaultConfig(): Config
 
 Function which returns the default config used by tailwind-merge. The tailwind-merge config is different from the Tailwind config. It is optimized for small bundle size and fast runtime performance because it is expected to run in the browser.
 
+### `fromTheme`
+
+```ts
+function fromTheme(key: string): ThemeGetter
+```
+
+Function to retrieve values from a theme scale, to be used in class groups.
+
+`fromTheme` doesn't return the values from the theme scale but rather another function which is used by tailwind-merge internally to retrieve the theme values. tailwind-merge can differentiate the theme getter function from a validator because it has a `isThemeGetter` property set to `true`.
+
+It can be used like this:
+
+```ts
+extendTailwindMerge({
+    theme: {
+        'my-scale': ['foo', 'bar']
+    },
+    classGroups: {
+        'my-group': [{ 'my-group': [fromTheme('my-scale'), fromTheme('spacing')] }]
+        'my-group-x': [{ 'my-group-x': [fromTheme('my-scale')] }]
+    }
+})
+```
+
 ### `extendTailwindMerge`
 
 ```ts
@@ -176,9 +403,11 @@ You provide it a `configExtension` object which gets [merged](#mergeconfigs) wit
 ```ts
 const customTwMerge = extendTailwindMerge({
     cacheSize: 0, // ← Disabling cache
-    prefixes: [
-        'my-custom-prefix', // ← Adding custom prefix
-    ],
+    // ↓ Add values to existing theme scale or create a new one
+    //   Not all theme keys form the Tailwind config are supported by default.
+    theme: {
+        spacing: ['sm', 'md', 'lg'],
+    },
     // ↓ Here you define class groups
     classGroups: {
         // ↓ The `foo` key here is the class group ID
@@ -230,7 +459,6 @@ const customTwMerge = createTailwindMerge(() => {
 
     return {
         cacheSize: 0,
-        prefixes: [...defaultConfig.prefixes, 'my-custom-prefix'],
         classGroups: {
             ...defaultConfig.classGroups,
             foo: ['foo', 'foo-2', { 'bar-baz': ['', '1', '2'] }],
@@ -285,9 +513,15 @@ const customTwMerge = createTailwindMerge(getDefaultConfig, (config) =>
 ```ts
 interface Validators {
     isLength(classPart: string): boolean
-    isCustomLength(classPart: string): boolean
+    isArbitraryLength(classPart: string): boolean
     isInteger(classPart: string): boolean
-    isCustomValue(classPart: string): boolean
+    isArbitraryValue(classPart: string): boolean
+    isTshirtSize(classPart: string): boolean
+    isArbitrarySize(classPart: string): boolean
+    isArbitraryPosition(classPart: string): boolean
+    isArbitraryUrl(classPart: string): boolean
+    isArbitraryWeight(classPart: string): boolean
+    isArbitraryShadow(classPart: string): boolean
     isAny(classPart: string): boolean
 }
 ```
@@ -300,10 +534,16 @@ const paddingClassGroup = [{ p: [validators.isLength] }]
 
 A brief summary for each validator:
 
--   `isLength` checks whether a class part is a number (`3`, `1.5`), a fraction (`3/4`), a custom length (`[3%]`, `[4px]`, `[length:var(--my-var)]`), or one of the strings `px`, `full` or `screen`.
--   `isCustomLength` checks for custom length values (`[3%]`, `[4px]`, `[length:var(--my-var)]`).
--   `isInteger` checks for integer values (`3`) and custom integer values (`[3]`).
--   `isCustomValue` checks whether the class part is enclosed in brackets (`[something]`)
+-   `isLength` checks whether a class part is a number (`3`, `1.5`), a fraction (`3/4`), a arbitrary length (`[3%]`, `[4px]`, `[length:var(--my-var)]`), or one of the strings `px`, `full` or `screen`.
+-   `isArbitraryLength` checks for arbitrary length values (`[3%]`, `[4px]`, `[length:var(--my-var)]`).
+-   `isInteger` checks for integer values (`3`) and arbitrary integer values (`[3]`).
+-   `isArbitraryValue` checks whether the class part is enclosed in brackets (`[something]`)
+-   `isTshirtSize`checks whether class part is a T-shirt size (`sm`, `xl`), optionally with a preceding number (`2xl`).
+-   `isArbitrarySize` checks whether class part is arbitrary value which starts with with `size:` (`[size:200px_100px]`) which is necessary for background-size classNames.
+-   `isArbitraryPosition` checks whether class part is arbitrary value which starts with with `position:` (`[position:200px_100px]`) which is necessary for background-position classNames.
+-   `isArbitraryUrl` checks whether class part is arbitrary value which starts with `url:` or `url(` (`[url('/path-to-image.png')]`, `url:var(--maybe-a-url-at-runtime)]`) which is necessary for background-image classNames.
+-   `isArbitraryWeight` checks whether class part is arbitrary value whcih starts with `weight:` or is a number (`[weight:var(--value)]`, `[450]`) which is necessary for font-weight classNames.
+-   `isArbitraryShadow` checks whether class part is arbitrary value which starts with the same pattern as a shadow value (`[0_35px_60px_-15px_rgba(0,0,0,0.3)]`), namely with two lengths separated by a underscore.
 -   `isAny` always returns true. Be careful with this validator as it might match unwanted classes. I use it primarily to match colors or when I'm ceertain there are no other class groups in a namespace.
 
 ### `Config`

package/dist/_virtual/_rollupPluginBabelHelpers.mjs

@@ -0,0 +1,20 @@
+function _extends() {
+  _extends = Object.assign || function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+
+    return target;
+  };
+
+  return _extends.apply(this, arguments);
+}
+
+export { _extends as extends };
+//# sourceMappingURL=_rollupPluginBabelHelpers.mjs.map

package/dist/_virtual/_rollupPluginBabelHelpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"_rollupPluginBabelHelpers.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { twMerge } from './lib/tailwind-merge';
+export { getDefaultConfig } from './lib/default-config';
+export { extendTailwindMerge } from './lib/extend-tailwind-merge';
+export { createTailwindMerge } from './lib/create-tailwind-merge';
+export type { Config } from './lib/types';
+export * as validators from './lib/validators';
+export { mergeConfigs } from './lib/merge-configs';
+export { fromTheme } from './lib/from-theme';