@wise/design-system-tailwindcss v0.5.6

@wise/design-system-tailwindcss

Experimental web implementation of Wise Design System, based upon Tailwind CSS.

Usage

Firstly, install the package and its peer dependencies (besides React):

pnpm add @wise/design-system-tailwindcss @transferwise/icons css-homogenizer

Fonts shall be loaded separately through @transferwise/neptune-css, by importing either of these styles:

• @transferwise/neptune-css/dist/css/neptune-core.css
• @transferwise/neptune-css/dist/css/neptune.css

With Tailwind CSS

1. Add build-time dependencies:

   pnpm add -D tailwindcss @tailwindcss/container-queries postcss postcss-import @csstools/postcss-rebase-url postcss-preset-env

2. Add .postcssrc.json to your project root:

   {
     "plugins": {
       "postcss-import": {},
       "@csstools/postcss-rebase-url": {},
       "tailwindcss/nesting": "postcss-nesting",
       "tailwindcss": {},
       "postcss-preset-env": {
         "features": {
           "float-clear-logical-values": false,
           "logical-overflow": false,
           "logical-overscroll-behavior": false,
           "logical-properties-and-values": false,
           "logical-resize": false,
           "logical-viewport-units": false,
           "nesting-rules": false
         }
       }
     }
   }

   This config:

   • Inlines @import statements, rebasing asset URLs when needed
   • Uses official CSS Nesting syntax over the Sass-like one
   • Provides extensive browser support via Browserslist

3. Within your TSConfig, use "moduleResolution": "Bundler" or "moduleResolution": "NodeNext". Package entry points may fail to resolve otherwise.

4. Add tailwind.config.ts to your project root, following this Next.js framework guide:

   import * as path from "node:path";
   
   import type { Config } from "tailwindcss";
   
   import tailwindBase from "@wise/design-system-tailwindcss/tailwind-base";
   
   export default {
     content: [
       "./src/**/*.{js,jsx,ts,tsx,mdx}",
       path.join(
         path.dirname(require.resolve("@wise/design-system-tailwindcss")),
         "**/*.js",
       ),
     ],
     presets: [tailwindBase],
   } satisfies Config;

   The Preflight core plugin is disabled, as base styles are provided by modern-normalize and css-homogenizer.

5. Add src/styles.css and import it from your app’s root:

   @import "tailwindcss/base";
   @import "@wise/design-system-tailwindcss/dist/preflight.css";
   /* TODO: Use global reset to simplify styling once the app is ready for it */
   /* @import "css-homogenizer/reset.css"; */
   
   @import "tailwindcss/components";
   
   @import "tailwindcss/utilities";

Migrating from Neptune CSS

Legacy utility class names can be converted to their Tailwind counterparts with a codemod:

pnpm dlx jscodeshift --extensions js,jsx,ts,tsx --transform ./node_modules/@wise/design-system-tailwindcss/codemods/neptune-css-utilities-to-tailwind.ts ./src/

Without Tailwind CSS (not recommended)

Import these styles from your app’s root:

import "@wise/design-system-tailwindcss/dist/preflight.css";
import "@wise/design-system-tailwindcss/dist/pregenerated.css";

Contributing

First, start the development server:

pnpm run dev

Then, you may modify components and stories within the src/ directory and see your changes take place in real time.