@daikin-oss/design-system-web-components 0.0.0 → 0.2.0

package/README.md

@@ -1,157 +1,214 @@
 # Daikin Design System - Web Components
 
-This project is an implementation of the Daikin Design Kit using web components.
+This project is an implementation of the Daikin Design Kit using Web Components.
 
-## Setup
+---
 
-Install dependencies:
+## Usage
+
+Start by installing the package:
 
 ```bash
-npm i
+npm i @daikin-oss/design-system-web-components
+```
+
+You can then import necessary components in your bundle:
+
+```javascript
+import "@daikin-oss/design-system-web-components/dist/components/button/index.js";
 ```
 
-## Build
+By default, out-of-the-box, the styles are for Daikin brand in light mode.
 
-Rollup is used to transform TypeScript code into JavaScript that runs in modern browsers.
-Tailwind classes are also purged.
+### Dark Mode and Brands/Themes
 
-Build components and output in /dist:
+_Due to the encapsulation of styles by the Web Components specification, how themes are applied may change in the future._
+
+For dark-mode support and non-daikin brands, you need to add the `tokens` package and include the CSS reference in your html:
 
 ```bash
-npm run build
+npm install '@daikin-oss/dds-tokens
 ```
 
-## Documentation
+#### Dark Mode
 
-Storybook is used to document design system components/tools/examples.
+Reference the CSS in HTML:
+
+```html
+<link
+  rel="stylesheet"
+  href="node_modules/@daikin-oss/dds-tokens/build/css/DKN/Dark/buttons.css"
+  media="(prefers-color-scheme: dark)"
+/>
+```
 
-To run in development:
+Using CSS `@import` with `prefers-color-scheme`:
 
-```bash
-npm run storybook
+```css
+@import "@daikin-oss/dds-tokens/css/daikin/Dark/buttons.css"
+  (prefers-color-scheme: dark);
+```
+
+#### Other brands/themes
+
+Reference the CSS in HTML:
+
+```html
+<link
+  rel="stylesheet"
+  href="node_modules/@daikin-oss/dds-tokens/build/css/AAF/Dark/buttons.css"
+  media="(prefers-color-scheme: light)"
+/>
+<link
+  rel="stylesheet"
+  href="node_modules/@daikin-oss/dds-tokens/build/css/AAF/Dark/buttons.css"
+  media="(prefers-color-scheme: dark)"
+/>
 ```
 
-To produce distributable files in /storybook-static folder:
+Using CSS `@import` with `prefers-color-scheme`:
 
-```bash
-npm run storybook:build
+```css
+@import "@daikin-oss/dds-tokens/css/aaf/Light/buttons.css"
+  (prefers-color-scheme: light);
+@import "@daikin-oss/dds-tokens/css/aaf/Dark/buttons.css"
+  (prefers-color-scheme: dark);
 ```
 
-## Linting
+---
+
+## Contribution
 
-Linting is done by ESLint for general linting of TypeScript and JavaScript, and [lit-analyzer](https://www.npmjs.com/package/lit-analyzer) to type check bindings in lit-html templates.
+The following are instructions for package contributors.
 
-To lint the project run:
+### Setup
+
+Clone and install dependencies:
 
 ```bash
-npm run lint
+git clone https://github.com/dsv-rp/DDS.git
+cd DDS
+
+# install dependencies
+npm i
+
+# install Playwright browsers
+npx playwright install
 ```
 
-## Testing
+### Build
 
-Visual regression testing is done by a combination of jest and puppeteer.
-Currently, web components has full support in most major frameworks [except for React](https://custom-elements-everywhere.com/).
-As such, we test both web components by themselves, and also test when imported by React:
+To build files for production:
 
 ```bash
-npm run test
+npm run build
 ```
 
-## Design Tokens
+Vite is used to transform TypeScript code into JavaScript that runs in modern browsers.
 
-1. **Source of Truth**: The `tokens` we use is the foundation of our design styles and was grabbed from https://github.com/dsv-rp/dds-tokens/tree/main.
+The built files are written to `/dist`.
 
-2. **Using in Components**: For the most part, we use the js variables to apply as the default style:
+### Documentation
 
-```
-import {
-    buttonColorBackgroundPrimaryActive
-} from '@daikinlab/dds-tokens/js/daikin/Light/variables.js';
+Storybook is used to document design system components/tools/examples.
 
-class DaikinButton extends LitElement implements DaikinButtonProps {
-    static styles = css`
-        :host {
-            --defaultButtonColorBackgroundPrimaryActive: ${unsafeCSS(
-                buttonColorBackgroundPrimaryActive
-            )};
-        }
-    `;
-
-    ...rest of the code
-}
-```
+To run in development mode:
 
-## Usage
+```bash
+# Web Components version
+npm run storybook
 
-```
-import '@daikin-zen/design-system-web-components/dist/components/button/index.js';
+# or React version
+npm run storybook:react
 ```
 
-By default, out-of-the-box, the styles are for Daikin brand in light mode.
+To produce distributable files in `/storybook-static/web-components` and `/storybook-static/react` folder:
 
-### Dark Mode and Brands/Themes
+```bash
+npm run build-storybook
+```
 
-For dark-mode support and non-daikin brands, you need to add the `tokens` package and include the CSS reference in your html:
+### Testing
 
-```
-npm install '@daikinlab/dds-tokens
-```
+There are currently two test suites: VRT (Visual Regression Test) and Interaction Test.
 
-#### Dark Mode
+Visual regression testing, placed in `*.visual.test.ts`, is done by Playwright running in a container.
+To eliminate rendering differences between environments, the browser which takes the screenshots must run on a container.
 
-Reference the CSS in HTML:
+Currently, Web Components has full support in most major frameworks [except for React](https://custom-elements-everywhere.com/).
+As such, we test both Web Components by themselves, and also test when imported by React:
 
-```
-<link rel="stylesheet" href="node_modules/@daikinlab/dds-tokens/build/css/DKN/Dark/buttons.css" media="(prefers-color-scheme: dark)">
-```
+```bash
+# start a container for running the browsers
+docker compose up -d
 
-Using CSS `@import` with `prefers-color-scheme`:
+# run VRT for Web Components and React versions
+npm run test:visual
 
+# stop the container
+docker compose down
 ```
-@import '@daikinlab/dds-tokens/css/daikin/Dark/buttons.css'
-    (prefers-color-scheme: dark);
 
-```
+For Podman users, use `podman-compose -f compose.podman.yaml` or `podman compose -f compose.podman.yaml` instead of `docker compose`.
 
-#### Other brands/themes
+To update snapshots, use `npm run test:visual-update`
 
-Reference the CSS in HTML:
+---
 
-```
-<link rel="stylesheet" href="node_modules/@daikinlab/dds-tokens/build/css/AAF/Dark/buttons.css" media="(prefers-color-scheme: light)">
-<link rel="stylesheet" href="node_modules/@daikinlab/dds-tokens/build/css/AAF/Dark/buttons.css" media="(prefers-color-scheme: dark)">
+Interaction testing, placed in `*.stories.ts`, is performed by Storybook, which also uses Playwright internally.
+Interaction tests do not use containers since rendering differences between environments do not matter.
+
+```bash
+npm run test:interaction
 ```
 
-Using CSS `@import` with `prefers-color-scheme`:
+### Linting and Type checking
 
-```
-@import '@daikinlab/dds-tokens/css/aaf/Light/buttons.css'
-    (prefers-color-scheme: light);
-@import '@daikinlab/dds-tokens/css/aaf/Dark/buttons.css'
-    (prefers-color-scheme: dark);
+Linting is performed by ESLint for general linting of JavaScript and TypeScript, and [lit-analyzer](https://www.npmjs.com/package/lit-analyzer) to type check bindings in lit-html templates.
+[cSpell](https://cspell.org/) is used for spell checking.
+[ls-lint](https://ls-lint.org/) is also used to ensure that consistent filenames are used.
+
+To lint the project, run:
+
+```bash
+npm run lint
+npx tsc -b
 ```
 
-## Tailwind
+If you encounter an `Unknown word` error, add the word to the `cspell-dictionary.txt`.
 
-There is a custom `daikinPlugin` managed [here](https://github.com/daikin-dsv/tailwind)
+### Design Tokens
 
-### Using with VSCode
+_We are looking for a more efficient way to import tokens._
 
-If you are using VSCode, there is a great [extension](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) you can use for auto-complete
+1. **Source of Truth**: The `tokens` we use is the foundation of our design styles and was grabbed from https://github.com/dsv-rp/dds-tokens/tree/main.
 
-Add the following to your VSCode `settings.json` file:
+2. **Using in Components**: For the most part, we use the js variables to apply as the default style:
+
+```javascript
+import {
+  buttonColorBackgroundPrimaryActive
+} from '@daikin-oss/dds-tokens/js/daikin/Light/variables.js';
 
-```json
-{
-    "editor.quickSuggestions": {
-        "other": true,
-        "comments": false,
-        "strings": true
-    },
-    "tailwindCSS.experimental.classRegex": ["ctl[(]`([^`]*)"]
+class DaikinButton extends LitElement implements DaikinButtonProps {
+  static styles = css`
+    :host {
+      --defaultButtonColorBackgroundPrimaryActive: ${unsafeCSS(
+        buttonColorBackgroundPrimaryActive
+      )};
+    }
+  `;
+
+  /* ...rest of the code */
 }
 ```
 
-You may need to set the regex if using a library like [classnames-template-literals](https://github.com/netlify/classnames-template-literals)
+### TailwindCSS
+
+There is a custom `daikinPlugin` managed [here](https://github.com/dsv-rp/tailwind).
+
+### Developing with VSCode
+
+This project provides recommended extensions and workspace settings for VSCode.
 
 References [Daikin Design Kit](https://www.figma.com/file/VyaaU8Ta9yzyf0PsURWSSf/DDS%3A-Design-Kit?node-id=2421%3A7943)

package/dist/cjs/colors.cjs

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const variables_js = require("@daikin-oss/dds-tokens/js/daikin/Light/variables.js");
+const DAIKIN_PRIMARY_BLUE = variables_js.colorBrandPrimary;
+const DAIKIN_SECONDARY_BLUE = variables_js.colorBlue40;
+const DAIKIN_DARK_GREY = variables_js.colorGrey90;
+const DAIKIN_MEDIUM_GREY = variables_js.colorGrey70;
+const DAIKIN_NEGATIVE = variables_js.colorRed60;
+const DAIKIN_WARNING = variables_js.colorYellow50;
+const DAIKIN_POSITIVE = variables_js.colorGreen60;
+const colors = {
+  daikinBlue: {
+    50: variables_js.colorBlue10,
+    100: variables_js.colorBlue20,
+    200: variables_js.colorBlue30,
+    300: DAIKIN_SECONDARY_BLUE,
+    400: variables_js.colorBlue50,
+    500: DAIKIN_PRIMARY_BLUE,
+    600: variables_js.colorBlue70,
+    700: variables_js.colorBlue80,
+    800: variables_js.colorBlue90,
+    900: variables_js.colorBlue100,
+    DEFAULT: DAIKIN_PRIMARY_BLUE
+  },
+  daikinNeutral: {
+    50: variables_js.colorGrey10,
+    100: variables_js.colorGrey20,
+    200: variables_js.colorGrey30,
+    300: variables_js.colorGrey40,
+    400: variables_js.colorGrey50,
+    500: variables_js.colorGrey60,
+    600: DAIKIN_MEDIUM_GREY,
+    700: variables_js.colorGrey80,
+    800: DAIKIN_DARK_GREY,
+    900: variables_js.colorGrey100
+  },
+  daikinRed: {
+    50: variables_js.colorRed10,
+    100: variables_js.colorRed20,
+    200: variables_js.colorRed30,
+    300: variables_js.colorRed40,
+    400: variables_js.colorRed50,
+    500: DAIKIN_NEGATIVE,
+    600: variables_js.colorRed70,
+    700: variables_js.colorRed80,
+    800: variables_js.colorRed90,
+    900: variables_js.colorRed100,
+    1e3: variables_js.colorRed110,
+    DEFAULT: DAIKIN_NEGATIVE
+  },
+  daikinYellow: {
+    50: variables_js.colorYellow10,
+    100: variables_js.colorYellow20,
+    200: variables_js.colorYellow30,
+    300: variables_js.colorYellow40,
+    400: DAIKIN_WARNING,
+    500: variables_js.colorYellow60,
+    600: variables_js.colorYellow70,
+    700: variables_js.colorYellow80,
+    800: variables_js.colorYellow90,
+    900: variables_js.colorYellow100,
+    1e3: variables_js.colorYellow110,
+    DEFAULT: DAIKIN_WARNING
+  },
+  daikinGreen: {
+    50: variables_js.colorGreen10,
+    100: variables_js.colorGreen20,
+    200: variables_js.colorGreen30,
+    300: variables_js.colorGreen40,
+    400: variables_js.colorGreen50,
+    500: DAIKIN_POSITIVE,
+    600: variables_js.colorGreen70,
+    700: variables_js.colorGreen80,
+    800: variables_js.colorGreen90,
+    900: variables_js.colorGreen100,
+    1e3: variables_js.colorGreen110,
+    DEFAULT: DAIKIN_POSITIVE
+  }
+};
+exports.colors = colors;

package/{lib → dist/cjs}/colors.d.ts

@@ -67,4 +67,3 @@ export declare const colors: {
         DEFAULT: string;
     };
 };
-//# sourceMappingURL=colors.d.ts.map

package/dist/cjs/components/button/daikin-button.cjs

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const variables_js = require("@daikin-oss/dds-tokens/js/daikin/Light/variables.js");
+const classVarianceAuthority = require("class-variance-authority");
+const lit = require("lit");
+const decorators_js = require("lit/decorators.js");
+const tailwind = require("../../tailwind.css.cjs");
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+const cvaButton = classVarianceAuthority.cva(
+  [
+    "inline-flex",
+    "justify-center",
+    "items-center",
+    "font-daikinSerif",
+    "font-bold",
+    "rounded-lg",
+    "tracking-wide",
+    "text-wrap",
+    "disabled:cursor-default",
+    "w-full",
+    "h-full"
+  ],
+  {
+    variants: {
+      intent: {
+        primary: [
+          "text-white",
+          "bg-[--buttonColorBackgroundPrimaryActive]",
+          "enabled:focus-visible:bg-[--buttonColorBackgroundPrimaryFocus]",
+          "enabled:hover:bg-[--buttonColorBackgroundPrimaryHover]",
+          "enabled:active:bg-[--buttonColorBackgroundPrimaryPress]",
+          "disabled:bg-[--buttonColorBackgroundPrimaryDisabled]",
+          "focus-visible:outline-none"
+        ],
+        secondary: [
+          "border-2",
+          "bg-white",
+          "text-daikinBlue-500",
+          "border-daikinBlue-500",
+          "enabled:hover:text-daikinBlue-300",
+          "enabled:hover:border-daikinBlue-300",
+          "enabled:active:text-daikinBlue-600",
+          "enabled:active:border-daikinBlue-600",
+          "enabled:focus-visible:text-daikinBlue-700",
+          "enabled:focus-visible:border-daikinBlue-700",
+          "disabled:border-daikinNeutral-300",
+          "disabled:text-daikinNeutral-400",
+          "disabled:border",
+          "focus-visible:outline-none"
+        ],
+        tertiary: [
+          "text-daikinBlue-400",
+          "bg-none",
+          "border-none",
+          "shadow-none",
+          "enabled:hover:bg-daikinNeutral-100",
+          "disabled:bg-transparent",
+          "disabled:text-daikinNeutral-400"
+        ],
+        primaryDanger: [
+          "bg-daikinRed",
+          "text-white",
+          "enabled:hover:bg-daikinRed-400",
+          "enabled:focus-visible:bg-daikinRed-700",
+          "enabled:active:bg-daikinRed-700",
+          "disabled:bg-daikinNeutral-300",
+          "focus-visible:outline-none"
+        ]
+      },
+      size: {
+        default: ["px-4", "text-[14px]"],
+        condensed: ["px-[10px]", "text-[12px]"]
+      }
+    },
+    defaultVariants: {
+      intent: "primary",
+      size: "condensed"
+    }
+  }
+);
+exports.DaikinButton = class DaikinButton extends lit.LitElement {
+  constructor() {
+    super(...arguments);
+    this.variant = "primary";
+    this.disabled = false;
+    this.rightIcon = "";
+    this.leftIcon = "";
+    this.href = "";
+    this.size = "default";
+    this.type = "button";
+    this.role = "button";
+    this.isLoading = false;
+  }
+  render() {
+    const buttonClassName = cvaButton({
+      intent: this.variant,
+      size: this.size
+    });
+    const content = lit.html`
+      <slot name="leftIcon"></slot>
+      <span><slot></slot></span>
+      <slot name="rightIcon"></slot>
+    `;
+    if (this.href) {
+      return lit.html` <a
+        href="${this.href}"
+        class="${buttonClassName}"
+        role="${this.role}"
+      >
+        ${content}
+      </a>`;
+    }
+    return lit.html`
+      <button
+        class="${buttonClassName}"
+        ?disabled="${this.disabled}"
+        type="${this.type}"
+        role="${this.role}"
+      >
+        ${content}
+      </button>
+    `;
+  }
+  focus(options) {
+    var _a, _b;
+    (_b = (_a = this.shadowRoot) == null ? void 0 : _a.querySelector("button")) == null ? void 0 : _b.focus(options);
+  }
+};
+exports.DaikinButton.styles = lit.css`
+    ${lit.unsafeCSS(tailwind.default)}
+
+    :host {
+      --buttonColorBackgroundPrimaryActive: ${lit.unsafeCSS(
+  variables_js.buttonColorBackgroundPrimaryActive
+)};
+      --buttonColorBackgroundPrimaryFocus: ${lit.unsafeCSS(
+  variables_js.buttonColorBackgroundPrimaryFocus
+)};
+      --buttonColorBackgroundPrimaryHover: ${lit.unsafeCSS(
+  variables_js.buttonColorBackgroundPrimaryHover
+)};
+      --buttonColorBackgroundPrimaryPress: ${lit.unsafeCSS(
+  variables_js.buttonColorBackgroundPrimaryPress
+)};
+      --buttonColorBackgroundPrimaryDisabled: ${lit.unsafeCSS(
+  variables_js.buttonColorBackgroundPrimaryDisabled
+)};
+
+      display: inline-block;
+      width: fit-content;
+      min-height: 42px;
+      height: 1px;
+    }
+
+    :host([size="condensed"]) {
+      min-height: 32px;
+    }
+  `;
+__decorateClass([
+  decorators_js.property({ type: String })
+], exports.DaikinButton.prototype, "variant", 2);
+__decorateClass([
+  decorators_js.property({ type: Boolean, reflect: true })
+], exports.DaikinButton.prototype, "disabled", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "rightIcon", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "leftIcon", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "href", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "size", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "type", 2);
+__decorateClass([
+  decorators_js.property({ type: String, reflect: true })
+], exports.DaikinButton.prototype, "role", 2);
+__decorateClass([
+  decorators_js.property({ type: Boolean })
+], exports.DaikinButton.prototype, "isLoading", 2);
+exports.DaikinButton = __decorateClass([
+  decorators_js.customElement("daikin-button")
+], exports.DaikinButton);

package/dist/cjs/components/button/daikin-button.d.ts

@@ -0,0 +1,59 @@
+import { LitElement } from 'lit';
+import { ARIARole } from '../../lit-analyzer-types';
+import { MergeVariantProps } from '../../type-utils';
+
+declare const cvaButton: (props?: ({
+    intent?: "primary" | "secondary" | "tertiary" | "primaryDanger" | null | undefined;
+    size?: "default" | "condensed" | null | undefined;
+} & import('class-variance-authority/types').ClassProp) | undefined) => string;
+type ButtonVariantProps = MergeVariantProps<typeof cvaButton>;
+/**
+ * Primary UI component for user interaction
+ */
+export declare class DaikinButton extends LitElement {
+    static readonly styles: import('lit').CSSResult;
+    /**
+     * Type of variant.
+     */
+    variant: ButtonVariantProps["intent"];
+    /**
+     * `true` if the button should be disabled.
+     */
+    disabled: boolean;
+    /**
+     * Set a icon in the right of button label.
+     */
+    rightIcon: string;
+    /**
+     * Set a icon in the left of button label.
+     */
+    leftIcon: string;
+    /**
+     * Link `href`. If present, this button is rendered as `<a>`.
+     */
+    href: string;
+    /**
+     * Specify the button size.
+     */
+    size: ButtonVariantProps["size"];
+    /**
+     * Specify the button type.
+     */
+    type: "button" | "submit" | "reset";
+    /**
+     * Specify the button role.
+     */
+    role: ARIARole;
+    /**
+     * Specify whether the button is loading.
+     */
+    isLoading: boolean;
+    render(): import('lit-html').TemplateResult<1>;
+    focus(options?: FocusOptions | undefined): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "daikin-button": DaikinButton;
+    }
+}
+export {};

package/dist/cjs/components/button/index.d.ts

@@ -0,0 +1 @@
+export * from './daikin-button';