Conditional classes with clsx and twMerge in Tailwind

Introduction

We use conditional classes to change styles based on conditions. clsx helps combine class names easily. twMerge cleans up duplicate Tailwind classes so styles don't conflict.

You want to add a class only if a button is active.

You want to switch background color based on a theme (dark or light).

You want to combine multiple class names dynamically in React or JavaScript.

You want to avoid conflicting Tailwind classes like 'bg-red-500' and 'bg-blue-500' at the same time.

Syntax

Tailwind

import clsx from 'clsx';
import { twMerge } from 'tailwind-merge';

const className = twMerge(clsx(
  'base-class',
  condition && 'conditional-class',
  anotherCondition ? 'class-true' : 'class-false'
));

clsx combines class names and ignores false or null values.

twMerge merges Tailwind classes and removes duplicates or conflicts.

Examples

Adds text-blue-500 only if isActive is true.

Tailwind

clsx('text-center', isActive && 'text-blue-500')

Returns bg-blue-500 because twMerge keeps the last conflicting class.

Tailwind

twMerge('bg-red-500', 'bg-blue-500')

Combines padding, text size based on isLarge, and background if isPrimary is true.

Tailwind

twMerge(clsx('p-4', isLarge ? 'text-lg' : 'text-sm', isPrimary && 'bg-green-500'))

Sample Program

This example shows a button that changes style and text when clicked. It uses clsx to add classes conditionally and twMerge to merge Tailwind classes without conflicts. The button background changes from blue to green when active, and the text color changes accordingly.

Tailwind

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Conditional Classes Example</title>
  <script src="https://cdn.tailwindcss.com"></script>
  <script type="module">
    import { twMerge } from 'https://cdn.skypack.dev/tailwind-merge';
    import clsx from 'https://cdn.skypack.dev/clsx';

    window.addEventListener('DOMContentLoaded', () => {
      const button = document.getElementById('myButton');
      let isActive = false;

      function updateButton() {
        const className = twMerge(clsx(
          'px-6 py-3 rounded font-semibold transition-colors',
          'bg-blue-500 text-white',
          isActive && 'bg-green-500 text-black',
          !isActive && 'hover:bg-blue-700'
        ));
        button.className = className;
        button.textContent = isActive ? 'Active' : 'Inactive';
        button.setAttribute('aria-pressed', isActive.toString());
      }

      button.addEventListener('click', () => {
        isActive = !isActive;
        updateButton();
      });

      updateButton();
    });
  </script>
</head>
<body class="flex items-center justify-center min-h-screen bg-gray-100">
  <button id="myButton" aria-pressed="false" aria-label="Toggle active state"></button>
</body>
</html>

Important Notes

Always use twMerge after clsx to avoid conflicting Tailwind classes.

Use semantic HTML and ARIA attributes for accessibility, like aria-pressed on toggle buttons.

Test your styles in different screen sizes to ensure responsiveness.

Summary

clsx helps combine class names easily and conditionally.

twMerge cleans up conflicting Tailwind classes to keep styles correct.

Use them together to write clean, dynamic, and conflict-free Tailwind CSS classes.

Practice

1. What is the main purpose of using clsx in a Tailwind CSS project?

easy

A. To conditionally combine multiple class names into one string

B. To automatically generate Tailwind CSS classes

C. To minify CSS files for faster loading

D. To replace Tailwind CSS with custom styles

Solution

1. Step 1: Understand clsx functionality

   clsx is a utility that helps combine class names conditionally, making it easier to apply classes based on logic.

2. Step 2: Compare options

   Only To conditionally combine multiple class names into one string correctly describes clsx's purpose. Other options describe unrelated tasks.

3. Final Answer:

   To conditionally combine multiple class names into one string -> Option A

4. Quick Check:

   clsx combines classes conditionally = C [OK]

Hint: clsx joins classes based on conditions, like a smart list builder [OK]

Common Mistakes:

• Thinking clsx generates CSS classes
• Confusing clsx with CSS minifiers
• Assuming clsx replaces Tailwind CSS

2. Which of the following is the correct syntax to use clsx to conditionally add the class bg-blue-500 only when isActive is true?

easy

A. clsx('bg-blue-500' && isActive)

B. clsx({ 'bg-blue-500': isActive })

C. clsx('bg-blue-500' || isActive)

D. clsx(bg-blue-500: isActive)

Solution

1. Step 1: Recall clsx conditional syntax

   clsx accepts an object where keys are class names and values are booleans to include or exclude classes.

2. Step 2: Analyze each option

   clsx({ 'bg-blue-500': isActive }) uses the correct object syntax. Options B and C misuse logical operators, and D has invalid syntax.

3. Final Answer:

   clsx({ 'bg-blue-500': isActive }) -> Option B

4. Quick Check:

   clsx uses object with class:condition = A [OK]

Hint: Use object syntax { 'class-name': condition } with clsx [OK]

Common Mistakes:

• Using logical operators inside clsx incorrectly
• Missing quotes around class names
• Writing invalid object syntax

3. Given the code snippet:

import clsx from 'clsx';
import { twMerge } from 'tailwind-merge';

const isPrimary = true;
const isDisabled = false;

const buttonClass = twMerge(clsx('px-4 py-2', {
  'bg-blue-500': isPrimary,
  'bg-gray-400': !isPrimary,
  'opacity-50 cursor-not-allowed': isDisabled
}));

console.log(buttonClass);

What will be printed in the console?

medium

A. "px-4 py-2 bg-blue-500"

B. "px-4 py-2 bg-gray-400 opacity-50 cursor-not-allowed"

C. "px-4 py-2 bg-blue-500 opacity-50 cursor-not-allowed"

D. "px-4 py-2 bg-gray-400"

Solution

1. Step 1: Evaluate clsx conditions

   isPrimary is true, so 'bg-blue-500' is included; !isPrimary is false, so 'bg-gray-400' is excluded; isDisabled is false, so 'opacity-50 cursor-not-allowed' is excluded.

2. Step 2: Apply twMerge

   twMerge cleans conflicting classes but here only 'bg-blue-500' is present, so no conflicts to resolve.

3. Final Answer:

   "px-4 py-2 bg-blue-500" -> Option A

4. Quick Check:

   clsx + twMerge output = "px-4 py-2 bg-blue-500" [OK]

Hint: Check boolean flags carefully, then apply twMerge to clean conflicts [OK]

Common Mistakes:

• Including classes with false conditions
• Ignoring twMerge effect on conflicting classes
• Mixing up true/false conditions

4. Identify the error in this code snippet using clsx and twMerge:

const isActive = true;
const classes = twMerge(clsx('text-white', {
  'bg-red-500': isActive,
  'bg-green-500' isActive === false
}));
console.log(classes);

medium

A. isActive variable is not defined

B. Using twMerge incorrectly without importing

C. clsx cannot accept objects as arguments

D. Missing comma between object properties inside clsx

Solution

1. Step 1: Check object syntax inside clsx

   Inside the object, properties must be separated by commas. The line 'bg-green-500' isActive === false lacks a comma after the first property.

2. Step 2: Verify other parts

   twMerge usage is correct assuming import exists, clsx accepts objects, and isActive is defined.

3. Final Answer:

   Missing comma between object properties inside clsx -> Option D

4. Quick Check:

   Object properties need commas = D [OK]

Hint: Check commas between object properties in clsx [OK]

Common Mistakes:

• Forgetting commas between object keys
• Assuming clsx can't take objects
• Ignoring variable definitions

5. You want to create a button that is bg-red-500 when error is true, bg-green-500 when success is true, and bg-gray-300 otherwise. Using clsx and twMerge, which code correctly applies these classes without conflicts?

hard

A. twMerge(clsx('px-4 py-2', {
'bg-red-500': error,
'bg-green-500': success,
'bg-gray-300': !error && !success
}))

B. clsx(twMerge('px-4 py-2'), {
'bg-red-500': error,
'bg-green-500': success,
'bg-gray-300': !error && !success
})

C. twMerge(clsx('px-4 py-2', error ? 'bg-red-500' : success ? 'bg-green-500' : 'bg-gray-300'))

D. clsx('px-4 py-2', error && 'bg-red-500', success && 'bg-green-500', !error && !success && 'bg-gray-300')

Solution

1. Step 1: Understand class conflicts

   Only one background color class should be applied at a time to avoid conflicts.

2. Step 2: Analyze each option

   twMerge(clsx('px-4 py-2', { 'bg-red-500': error, 'bg-green-500': success, 'bg-gray-300': !error && !success })) uses clsx with multiple conditional classes that can conflict; twMerge will merge but logic is less clear. twMerge(clsx('px-4 py-2', error ? 'bg-red-500' : success ? 'bg-green-500' : 'bg-gray-300')) uses nested ternary to pick exactly one class, then twMerge cleans up. clsx(twMerge('px-4 py-2'), { 'bg-red-500': error, 'bg-green-500': success, 'bg-gray-300': !error && !success }) misuses clsx and twMerge order. clsx('px-4 py-2', error && 'bg-red-500', success && 'bg-green-500', !error && !success && 'bg-gray-300') uses clsx but may add multiple bg classes simultaneously.

3. Step 3: Choose best practice

   twMerge(clsx('px-4 py-2', error ? 'bg-red-500' : success ? 'bg-green-500' : 'bg-gray-300')) cleanly selects one bg class and uses twMerge properly.

4. Final Answer:

   twMerge(clsx('px-4 py-2', error ? 'bg-red-500' : success ? 'bg-green-500' : 'bg-gray-300')) -> Option C

5. Quick Check:

   Use ternary for exclusive classes + twMerge = B [OK]

Hint: Use ternary to pick one class, then twMerge to clean conflicts [OK]

Common Mistakes:

• Applying multiple conflicting bg classes at once
• Wrong order of clsx and twMerge calls
• Not ensuring only one bg class is active