github chakra-ui/panda @pandacss/core@0.36.0

latest releases: @pandacss/token-dictionary@0.51.1, @pandacss/types@0.51.1, @pandacss/studio@0.51.1...
10 months ago

Minor Changes

  • 2691f16: Add config.themes to easily define and apply a theme on multiple tokens at once, using data attributes and CSS
    variables.

    Can pre-generate multiple themes with token overrides as static CSS, but also dynamically import and inject a theme
    stylesheet at runtime (browser or server).

    Example:

    // panda.config.ts
    import { defineConfig } from "@pandacss/dev";
    
    export default defineConfig({
      // ...
      // main theme
      theme: {
        extend: {
          tokens: {
            colors: {
              text: { value: "blue" },
            },
          },
          semanticTokens: {
            colors: {
              body: {
                value: {
                  base: "{colors.blue.600}",
                  _osDark: "{colors.blue.400}",
                },
              },
            },
          },
        },
      },
      // alternative theme variants
      themes: {
        primary: {
          tokens: {
            colors: {
              text: { value: "red" },
            },
          },
          semanticTokens: {
            colors: {
              muted: { value: "{colors.red.200}" },
              body: {
                value: {
                  base: "{colors.red.600}",
                  _osDark: "{colors.red.400}",
                },
              },
            },
          },
        },
        secondary: {
          tokens: {
            colors: {
              text: { value: "blue" },
            },
          },
          semanticTokens: {
            colors: {
              muted: { value: "{colors.blue.200}" },
              body: {
                value: {
                  base: "{colors.blue.600}",
                  _osDark: "{colors.blue.400}",
                },
              },
            },
          },
        },
      },
    });

    Pregenerating themes

    By default, no additional theme variant is generated, you need to specify the specific themes you want to generate in
    staticCss.themes to include them in the CSS output.

    // panda.config.ts
    import { defineConfig } from "@pandacss/dev";
    
    export default defineConfig({
      // ...
      staticCss: {
        themes: ["primary", "secondary"],
      },
    });

    This will generate the following CSS:

    @layer tokens {
      :where(:root, :host) {
        --colors-text: blue;
        --colors-body: var(--colors-blue-600);
      }
    
      [data-panda-theme="primary"] {
        --colors-text: red;
        --colors-muted: var(--colors-red-200);
        --colors-body: var(--colors-red-600);
      }
    
      @media (prefers-color-scheme: dark) {
        :where(:root, :host) {
          --colors-body: var(--colors-blue-400);
        }
    
        [data-panda-theme="primary"] {
          --colors-body: var(--colors-red-400);
        }
      }
    }

    An alternative way of applying a theme is by using the new styled-system/themes entrypoint where you can import the
    themes CSS variables and use them in your app.

    ℹ️ The styled-system/themes will always contain every themes (tree-shaken if not used), staticCss.themes only
    applies to the CSS output.

    Each theme has a corresponding JSON file with a similar structure:

    {
      "name": "primary",
      "id": "panda-themes-primary",
      "dataAttr": "primary",
      "css": "[data-panda-theme=primary] { ... }"
    }

    ℹ️ Note that for semantic tokens, you need to use inject the theme styles, see below

    Dynamically import a theme using its name:

    import { getTheme } from "../styled-system/themes";
    
    const theme = await getTheme("red");
    //    ^? {
    //     name: "red";
    //     id: string;
    //     css: string;
    // }

    Inject the theme styles into the DOM:

    import { injectTheme } from "../styled-system/themes";
    
    const theme = await getTheme("red");
    injectTheme(document.documentElement, theme); // this returns the injected style element

    SSR example with NextJS:

    // app/layout.tsx
    import { Inter } from "next/font/google";
    import { cookies } from "next/headers";
    import { ThemeName, getTheme } from "../../styled-system/themes";
    
    export default async function RootLayout({
      children,
    }: {
      children: React.ReactNode;
    }) {
      const store = cookies();
      const themeName = store.get("theme")?.value as ThemeName;
      const theme = themeName && (await getTheme(themeName));
    
      return (
        <html lang="en" data-panda-theme={themeName ? themeName : undefined}>
          {themeName && (
            <head>
              <style
                type="text/css"
                id={theme.id}
                dangerouslySetInnerHTML={{ __html: theme.css }}
              />
            </head>
          )}
          <body>{children}</body>
        </html>
      );
    }
    
    // app/page.tsx
    import { getTheme, injectTheme } from "../../styled-system/themes";
    
    export default function Home() {
      return (
        <>
          <button
            onClick={async () => {
              const current = document.documentElement.dataset.pandaTheme;
              const next = current === "primary" ? "secondary" : "primary";
              const theme = await getTheme(next);
              setCookie("theme", next, 7);
              injectTheme(document.documentElement, theme);
            }}
          >
            swap theme
          </button>
        </>
      );
    }
    
    // Set a Cookie
    function setCookie(cName: string, cValue: any, expDays: number) {
      let date = new Date();
      date.setTime(date.getTime() + expDays * 24 * 60 * 60 * 1000);
      const expires = "expires=" + date.toUTCString();
      document.cookie = cName + "=" + cValue + "; " + expires + "; path=/";
    }

    Finally, you can create a theme contract to ensure that all themes have the same structure:

    import { defineThemeContract } from "@pandacss/dev";
    
    const defineTheme = defineThemeContract({
      tokens: {
        colors: {
          red: { value: "" }, // theme implementations must have a red color
        },
      },
    });
    
    defineTheme({
      selector: ".theme-secondary",
      tokens: {
        colors: {
          // ^^^^   Property 'red' is missing in type '{}' but required in type '{ red: { value: string; }; }'
          //
          // fixed with
          // red: { value: 'red' },
        },
      },
    });
  • fabdabe: ## Changes

    When using strictTokens: true, if you didn't have tokens (or semanticTokens) on a given Token category, you'd
    still not be able to use any values in properties bound to that category. Now, strictTokens will correctly only
    restrict properties that have values in their token category.

    Example:

    // panda.config.ts
    
    export default defineConfig({
      // ...
      strictTokens: true,
      theme: {
        extend: {
          colors: {
            primary: { value: "blue" },
          },
          // borderWidths: {}, // ⚠️ nothing defined here
        },
      },
    });
    // app.tsx
    css({
      // ❌ before this PR, TS would throw an error as you are supposed to only use Tokens
      // even thought you don't have any `borderWidths` tokens defined !
    
      // ✅ after this PR, TS will not throw an error anymore as you don't have any `borderWidths` tokens
      // if you add one, this will error again (as it's supposed to)
      borderWidths: "123px",
    });

    Description

    • Simplify typings for the style properties.
    • Add the csstype comments for each property.

    You will now be able to see a utility or csstype values in 2 clicks !

    How

    Instead of relying on TS to infer the correct type for each properties, we now just generate the appropriate value for
    each property based on the config.

    This should make it easier to understand the type of each property and might also speed up the TS suggestions as there's
    less to infer.

Patch Changes

  • Updated dependencies [3af3940]
  • Updated dependencies [861a280]
  • Updated dependencies [2691f16]
  • Updated dependencies [340f4f1]
  • Updated dependencies [fabdabe]
    • @pandacss/token-dictionary@0.36.0
    • @pandacss/types@0.36.0
    • @pandacss/is-valid-prop@0.36.0
    • @pandacss/logger@0.36.0
    • @pandacss/shared@0.36.0

Don't miss a new panda release

NewReleases is sending notifications on new releases.