How to Properly Style with SASS/SCSS in React

Discover how to effectively use `SASS`/`SCSS` in your React projects, including solutions for class name conflicts and using variants properly with styled components.
---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Can't style with SASS/SCSS in React properly

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Properly Style with SASS/SCSS in React: A Complete Guide

When working with React and SASS/SCSS, developers often face challenges with styling, particularly when it comes to applying variants and class names. If you've ever found yourself in a situation where your SCSS styles aren't being applied as expected, you're not alone. In this guide, we'll tackle a specific issue related to styling class names in a React component using SCSS, and provide an effective solution.

The Problem at Hand

Imagine you have an SCSS stylesheet like the one below:

[[See Video to Reveal this Text or Code Snippet]]

[[See Video to Reveal this Text or Code Snippet]]

When you run your code, you might notice that the class names are getting jumbled up. For example, instead of just seeing regular or small, you find something like UserIcon_userIcon__1jFAP regular mb-2 as the class name. This can be frustrating, especially since it appears that your Bootstrap styles are working fine.

Common Queries

You may have questions including:

How can I remove the class name renaming?

How can I successfully implement the .regular and .small classes so they work with the jumbled class names?

Solving the Styling Issue

Let's break down the solution to ensure your styles are applied correctly, using the class name managed by the CSS modules and combining it with your desired variants.

Step 1: Modify the Class Name Reference

Rather than directly appending the variant in your JSX as a plain string, you should reference it from your styles object. This will avoid issues with class name scoping. Change your class name assignment in your UserIcon component to the following:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of the Fix

Using styles[variant]: By using styles[variant], you leverage the actual class names generated by your SCSS module. This ensures that you are referencing the correct class for the variant (.regular or .small), which resolves the naming conflict.

Dynamic Class Binding: This approach allows React to dynamically bind the specified variant class, making your styles effective without any confusion from CSS module renaming.

Conclusion

Styling with SASS/SCSS in React can be tricky due to class name scoping and conflicts. However, by correctly referencing your variant classes from the styles object, you can seamlessly apply CSS modules while avoiding issues with class name jumbles. The solution provided here not only resolves the styling issue but also ensures that your components maintain a clean and organized styling structure.

The next time you work on a React project with SCSS, remember this approach to handle variants effortlessly. Happy coding!