@daikin-oss/tailwind

tailwind

Tailwind plugin utilizing Daikin-specific styles

Installation

Install the tokens and plugin from npm:

npm install @daikin-oss/dds-tokens
npm install -D @daikin-oss/tailwind

Usage

Depending on your Tailwind version, you can set up the plugin in one of two ways:

Tailwind v3 and earlier

Use the plugin in your tailwind config:

const daikinPlugin = require("@daikin-oss/tailwind");

module.exports = {
  content: ["./src/**/*.js"],
  theme: {},
  variants: {
    extend: {},
  },
  plugins: [daikinPlugin({}), ...otherPlugins],
};

Tailwind v4

Tailwind v4 no longer uses a JavaScript configuration file by default. Instead, you can enable plugins directly from your CSS entrypoint:

@import "tailwindcss";
@plugin '@daikin-oss/tailwind';

Import CSS Variables (required for both v3 and v4)

To use Daikin design tokens in your project, import the CSS variables:

import "@daikin-oss/dds-tokens/css/daikin/Light/variables.css";

See dds-tokens repository for more information.

Basic Usage

Colors

You can use extended colors anywhere you usually would.

<button
  class="bg-dds-color-common-brand-default hover:bg-dds-color-common-brand-hover"
>
  My Button
</button>

For available colors, see Color / Reference and Color / Semantic Color pages in our design docs. We recommend using semantic colors to support themes in consistent way.

Font Family

A daikinSerif fontFamily option has been added.

<h1 class="text-xl font-medium font-daikinSerif">Text</h1>

Note that the current default font is Roboto, so you would have to import that on your own.

Build and Test

npm run lint
npm run typecheck
npm run build
npm run test:attw