Tailwind colors with CSS variables results in broken primary/gray palette

aautcq commented 1 month ago

Environment

Operating System: Linux
Node Version: v18.20.3
Nuxt Version: 3.12.1
CLI Version: 3.12.0
Nitro Version: 2.9.6
Package Manager: pnpm@8.15.6
Builder: -
User Config: modules
Runtime Modules: @nuxt/ui@2.17.0
Build Modules: -

Version

v2.17.0

Reproduction

https://stackblitz.com/edit/nuxt-ui-keperh

Description

When using CSS variables with tailwind, NuxtUI fails to generate the corresponding primary or gray color palette.

For example (see reproduction for more details):

// tailwind.config.ts
import type { Config } from 'tailwindcss';

export default <Partial<Config>>{
  theme: {
    extend: {
      colors: {
        foo: {
          50: 'rgb(var(--color-foo-50) / <alpha-value>)',
          100: 'rgb(var(--color-foo-100) / <alpha-value>)',
          ...
        },
      },
    },
  },
};

In the main CSS file:

@layer base {
  :root {
    --color-foo-50: 240 253 253;
    --color-foo-100: 191 239 242;
    ...
  }
}

In app.config.ts:

export default defineAppConfig({
  ui: {
    primary: 'foo',
  },
});

And the resulting styles injected in the root is:

:root {
    --color-primary-50: null;
    --color-primary-100: null;
    ...
}

Additional context

This, I believe, is due to the colors plugin which expects the tailwind config to contain HEX codes only, and attempts to convert them to RGB data using the hexToRgb utility function. I'll submit a PR soon to attempt to fix this.

Logs

No response

benjamincanac commented 1 month ago

What is it you're trying to achieve? This is exactly what the primary color is for already:

aautcq commented 1 month ago

Sorry if I wasn't very clear :)

Let’s say I have a color palette that is dynamic and I need to fetch it from my backend. I want to use this palette as NuxtUI's primary color and also for other stylings in my app. I guess I could simply work with the tailwind primary color generated by NuxtUI, and override the values of the CSS variables in the root after having fetched the palette, like so:

const palette = await fetchPaletteFromBackend() // { 50: '240 253 253', 100: '191 239 242', ...}

// Some formatting
const rootVariables = Object.entries(palette).reduce((acc, [key, value]) => {
  return acc + `--color-primary-${key}: ${value};`
}, '')

// Override the root
useHead({ style: `:root {${rootVariables}}` })

This works just fine, but I see a few catches here:

I'd have to use the primary or gray colors generated by NuxtUI to write styles throughout my app, which does not feel as a very good practice. If there is a breaking change and the colors names change, or if I want to switch to another components library, this will increase the amount of work I have to do. In general, I'd prefer to use the ui setting in the app.config.ts file to link the primary and gray colors to another color that sits in my tailwind config and never use primary or gray directly in my app
There is no mention of the primary color in the colors section of my app's tailwind config, nor in my app.config.ts file. Any newcomer to my codebase would need to know that NuxtUI adds the primary color to tailwind
My root remains polluted with the original values from the default green color (see screenshot below, where the 1st set of variables comes from my snippet, and the 2nd corresponds to the tailwind green)

For all these reasons, it would feel cleaner to me if I could use a tailwind color palette that is written using CSS variables as NuxtUI's primary color.

Please let me know if I'm missing some other obvious way to achieve this. I'm still new to Nuxt, I might just be embarrassing myself here 🌝

Also, the above is just an example, and there is already an open issue regarding this precise use case. But there might be some other cases where I would need to use CSS variables with tailwind, e.g., if I want to use something like Radix colors and need to change the value of a color depending if I'm in light or dark mode.

The real question is: how should NuxtUI handle the case where a palette generated using CSS variables is used as the primary or gray color?

If we the answer is "use HEX codes only", then it might be worth raising an error in the colors plugin when something other than a HEX code palette is provided, and also maybe mention it in the docs?

github-actions[bot] commented 1 week ago

This issue is stale because it has been open for 30 days with no activity.

nuxt / ui