tailwindcss-overload

tailwindcss-overload

Using

yarn add tailwindcss-overload

You have a component with some baked in TailwindCSS classes:

export const Paragraph = ({ children, className = "", ...rest }) => (
  <p {...rest} className={`text-gray-800 font-sans mb-6 ${className}`}>
    {children}
  </p>
);

All is good. Until in one scenario you just want the margin-bottom to be different than the default 6:

<Paragraph className="mb-2">...</Paragarph>

Unfortunately whether or not this works is up to the whims of the "Cascading" in CSS.

No more!

Rewrite the component to use the withTailwindOverload higher order component.

import { withTailwindOverload } from "tailwindcss-overload";

const Paragraph = ({ children, ...rest }) => {
  return <p {...rest}>{children}</p>;
};

Paragraph.defaultClassName = "text-gray-800 font-sans mb-6";

export default Paragraph;

Now when <Paragraph className="mb-2">...</Paragraph> is rendered the default mb is removed and the overloaded utility works regardless of "Cascading".

<p class="text-gray-800 font-sans mb-2">...</p>

Contributing

Issues, PRs and ideas welcome.

Next Steps

Need to add more unit tests that cover large class strings, such as an extremely responsive component. For now I think most of the value comes out of overloading defaults of simple components like margin or color on Typography, widths or max-widths on Containers.. but we'll see.