@adobe-commerce/elsie 1.0.0-alpha1

package/src/components/Incrementer/Incrementer.stories.tsx

@@ -0,0 +1,163 @@
+// https://storybook.js.org/docs/7.0/preact/writing-stories/introduction
+import type { Meta, StoryObj } from '@storybook/preact';
+import {
+  Incrementer,
+  IncrementerProps,
+} from '@adobe/elsie/components/Incrementer';
+import { action } from '@storybook/addon-actions';
+import { expect, userEvent, within } from '@storybook/test';
+
+/**
+ * Use Incrementer to let users increase or decrease a value.
+ */
+const meta: Meta<IncrementerProps> = {
+  title: 'Components/Incrementer',
+  component: Incrementer,
+  argTypes: {
+    name: {
+      description: 'Field name (used for mapping the value in a form)',
+      type: {
+        required: false,
+        name: 'string',
+      },
+    },
+    value: {
+      description: 'Field value',
+      type: 'string',
+    },
+    size: {
+      description: 'medium | large',
+      defaultValue: { summary: 'medium' },
+      options: ['medium', 'large'],
+      control: { type: 'radio' },
+      type: 'string',
+    },
+    min: {
+      description: 'Minimum value',
+      type: 'number',
+    },
+    max: {
+      description: 'Maximum value',
+      type: 'number',
+    },
+    disabled: {
+      description: 'Whether or not the field is disabled',
+      control: 'boolean',
+      defaultValue: false,
+    },
+    'aria-label': {
+      description: 'Aria label',
+      type: 'string',
+    },
+    onValue: {
+      description: 'Callback function to handle value change',
+      type: 'function',
+    },
+    onUpdateError: {
+      description: 'Callback function to handle error',
+      type: 'function',
+    },
+    error: {
+      description: 'Whether or not the field shows an error',
+      type: 'boolean',
+    },
+    success: {
+      description:
+        'Whether or not the field value has been updated successfully',
+      type: 'boolean',
+    },
+    maxLength: {
+      description: 'Maximum length of the input field',
+      type: 'number',
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<IncrementerProps>;
+
+export const Primary: Story = {
+  args: {
+    size: 'medium',
+    onValue: action('onValue'),
+    name: 'incrementerField',
+    value: '1',
+    min: 1,
+    max: 100,
+    disabled: false,
+    'aria-label': 'Quantity',
+  },
+  play: async () => {
+    const canvasElement = document.querySelector(
+      '#storybook-root'
+    ) as HTMLElement;
+    const canvas = within(canvasElement);
+    const decreaseButton = document.querySelector(
+      'button[aria-label="Decrease Quantity"]'
+    ) as HTMLElement;
+    const inputField = document.querySelector('input') as HTMLElement;
+    const increaseButton = document.querySelector(
+      'button[aria-label="Increase Quantity"]'
+    ) as HTMLElement;
+
+    // Without this wait test failing intermittently as click event is triggering before even element fully loaded
+    await new Promise((resolve) => setTimeout(resolve, 500));
+    await userEvent.click(increaseButton);
+    await expect(await canvas.findByDisplayValue('2')).toBeTruthy();
+
+    await userEvent.click(decreaseButton);
+    await expect(await canvas.findByDisplayValue('1')).toBeTruthy();
+
+    await userEvent.clear(inputField);
+    await userEvent.type(inputField, '99');
+    await expect(await canvas.findByDisplayValue('99')).toBeTruthy();
+
+    await userEvent.click(increaseButton);
+    await expect(await canvas.findByDisplayValue('100')).toBeTruthy();
+
+    await userEvent.click(increaseButton);
+    await expect(await canvas.findByDisplayValue('100')).toBeTruthy();
+
+    await userEvent.click(decreaseButton);
+    await expect(await canvas.findByDisplayValue('99')).toBeTruthy();
+
+    await userEvent.clear(inputField);
+    await userEvent.type(inputField, '1');
+    await expect(await canvas.findByDisplayValue('1')).toBeTruthy();
+  },
+};
+
+export const WithError = {
+  args: {
+    size: 'medium',
+    onValue: action('onValue'),
+    onBlur: action('onBlur'),
+    name: 'incrementerField',
+    value: '1001',
+    min: 1,
+    max: 100,
+    disabled: false,
+    'aria-label': 'Quantity',
+  },
+  play: async () => {
+    const canvasElement = document.querySelector(
+      '#storybook-root'
+    ) as HTMLElement;
+    const canvas = within(canvasElement);
+    const increaseButton = document.querySelector(
+      'button[aria-label="Increase Quantity"]'
+    ) as HTMLElement;
+
+    await new Promise((resolve) => setTimeout(resolve, 500));
+    await userEvent.click(increaseButton);
+    await expect(await canvas.findByDisplayValue('1001')).toBeTruthy();
+
+    const error = document.querySelector(
+      '.dropin-incrementer__content--error-message'
+    ) as HTMLElement;
+
+    await expect(error).toBeVisible();
+    await expect(error).toHaveTextContent('Maximum quantity is 100');
+  },
+};

package/src/components/Incrementer/Incrementer.tsx

@@ -0,0 +1,183 @@
+import { FunctionComponent } from 'preact';
+import { useState, useCallback } from 'preact/hooks';
+import { HTMLAttributes } from 'preact/compat';
+import { classes, debounce } from '@adobe/elsie/lib';
+import { Add, Minus } from '@adobe/elsie/icons';
+import { Icon } from '@adobe/elsie/components/Icon';
+import { Localizer, Text } from '@adobe/elsie/i18n';
+import '@adobe/elsie/components/Incrementer/Incrementer.css';
+
+export interface IncrementerProps
+  extends Omit<HTMLAttributes<HTMLInputElement>, 'size'> {
+  name?: string;
+  size?: 'medium' | 'large';
+  onValue?: (value: any) => void;
+  onUpdateError?: (error: Error) => void;
+  error?: boolean;
+  success?: boolean;
+  min?: number;
+  max?: number;
+  disabled?: boolean;
+  maxLength?: number;
+}
+
+export const Incrementer: FunctionComponent<IncrementerProps> = ({
+  name,
+  value = '1',
+  className,
+  disabled,
+  error,
+  success,
+  min,
+  max,
+  onValue,
+  onUpdateError,
+  size = 'medium',
+  ...props
+}) => {
+  const [currentValue, setCurrentValue] = useState<number>(Number(value));
+  const minValue = Number(min);
+  const maxValue = Number(max);
+  const isInvalid = error || currentValue < minValue || currentValue > maxValue;
+
+  const errorMessage =
+    currentValue < minValue
+      ? 'Dropin.Incrementer.minQuantityMessage'
+      : currentValue > maxValue
+        ? 'Dropin.Incrementer.maxQuantityMessage'
+        : 'Dropin.Incrementer.errorMessage';
+
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  const debouncedOnValueHandler = useCallback(
+    debounce(async (newValue: any) => {
+      if (onValue) {
+        try {
+          onValue(newValue);
+        } catch (e) {
+          if (onUpdateError) {
+            onUpdateError(e as Error);
+          }
+        }
+      }
+    }, 200),
+    [onValue, onUpdateError]
+  );
+
+  const handleIncrementer = (_value: number) => {
+    let newValue = _value;
+    debouncedOnValueHandler(newValue);
+    setCurrentValue(newValue);
+  };
+
+  return (
+    <div
+      className={classes([
+        'dropin-incrementer',
+        `dropin-incrementer--${size}`,
+        className,
+      ])}
+    >
+      <div
+        className={classes([
+          'dropin-incrementer__content',
+          `dropin-incrementer__content--${size}`,
+          [`dropin-incrementer__content--error`, isInvalid],
+          [`dropin-incrementer__content--success`, success],
+          [`dropin-incrementer__content--disabled`, disabled],
+        ])}
+      >
+        {/* Minus Button */}
+        <div
+          className={classes([
+            'dropin-incrementer__button-container',
+            [`dropin-incrementer__button-container--disabled`, disabled],
+          ])}
+        >
+          <Localizer>
+            <button
+              type="button"
+              className={classes([
+                'dropin-incrementer__decrease-button',
+                [`dropin-incrementer__decrease-button--disabled`, disabled],
+              ])}
+              onClick={() => handleIncrementer(currentValue - 1)}
+              disabled={disabled || currentValue < minValue + 1}
+              aria-label={
+                (<Text id="Dropin.Incrementer.decreaseLabel" />) as any
+              }
+            >
+              <Icon
+                source={Minus}
+                size="16"
+                stroke="1"
+                viewBox="4 2 20 20"
+                className="dropin-incrementer__down"
+              />
+            </button>
+          </Localizer>
+        </div>
+
+        {/* Input Field */}
+        <input
+          className="dropin-incrementer__input"
+          max={max}
+          min={min}
+          step={1}
+          type="number"
+          name={name}
+          value={currentValue}
+          disabled={disabled}
+          onBlur={() => {
+            handleIncrementer(Number(currentValue));
+          }}
+          onChange={(e) => {
+            const newValue = e.currentTarget.value;
+            if (newValue !== '') {
+              handleIncrementer(Number(newValue));
+            }
+          }}
+          {...props}
+        />
+
+        <div
+          className={classes([
+            'dropin-incrementer__button-container',
+            [`dropin-incrementer__button-container--disabled`, disabled],
+          ])}
+        >
+          {/* Plus/Add button */}
+          <Localizer>
+            <button
+              type="button"
+              className={classes([
+                'dropin-incrementer__increase-button',
+                [`dropin-incrementer__increase-button--disabled`, disabled],
+              ])}
+              onClick={() => handleIncrementer(currentValue + 1)}
+              disabled={disabled || currentValue > maxValue - 1}
+              aria-label={
+                (<Text id="Dropin.Incrementer.increaseLabel" />) as any
+              }
+            >
+              <Icon
+                source={Add}
+                size="16"
+                stroke="1"
+                viewBox="4 2 20 20"
+                className="dropin-incrementer__add"
+              />
+            </button>
+          </Localizer>
+        </div>
+      </div>
+      {isInvalid && (
+        <p className="dropin-incrementer__content--error-message">
+          <Text
+            id={errorMessage}
+            fields={{ minQuantity: min, maxQuantity: max }}
+          />
+        </p>
+      )}
+    </div>
+  );
+};

package/src/components/Incrementer/index.ts

@@ -0,0 +1 @@
+export * from '@adobe/elsie/components/Incrementer/Incrementer';

package/src/components/Input/Input.css

@@ -0,0 +1,295 @@
+/* https://cssguidelin.es/#bem-like-naming */
+
+/* Input */
+.dropin-input {
+  background-color: transparent;
+  border-color: var(--color-neutral-600);
+  border-radius: var(--shape-border-radius-1);
+  border-style: inset solid;
+  color: var(--color-neutral-800);
+  -webkit-box-sizing: border-box; /* Safari/Chrome, other WebKit */
+  -moz-box-sizing: border-box; /* Firefox, other Gecko */
+  box-sizing: border-box;
+  width: 100%;
+  max-width: 100%;
+  z-index: 1;
+}
+
+.dropin-input[type='number'],
+.dropin-input[type='text'] {
+  -moz-appearance: textfield;
+  appearance: textfield;
+}
+
+.dropin-input:focus {
+  outline: none;
+  box-shadow: none;
+}
+
+.dropin-input:disabled {
+  border-top-left-radius: var(--shape-border-radius-1);
+  border-top-right-radius: var(--shape-border-radius-1);
+  border-color: var(--color-neutral-500);
+  background-color: var(--color-neutral-300);
+  color: var(--color-neutral-500);
+}
+
+/* Placeholder */
+.dropin-input::placeholder,
+.dropin-input::-webkit-input-placeholder,
+.dropin-input::-ms-input-placeholder {
+  color: var(--color-neutral-700);
+  opacity: 1;
+}
+
+.dropin-input:disabled::-webkit-input-placeholder {
+  /* WebKit browsers */
+  color: var(--color-neutral-500);
+}
+.dropin-input:disabled:-moz-placeholder {
+  /* Mozilla Firefox 4 to 18 */
+  color: var(--color-neutral-500);
+}
+.dropin-input:disabled::-moz-placeholder {
+  /* Mozilla Firefox 19+ */
+  color: var(--color-neutral-500);
+}
+.dropin-input:disabled:-ms-input-placeholder {
+  /* Internet Explorer 10+ */
+  color: var(--color-neutral-500);
+}
+
+/* Containers */
+.dropin-input-container {
+  --icon-size: var(--spacing-small);
+  display: flex;
+  align-items: center;
+  position: relative;
+}
+
+.dropin-input-label-container {
+  position: relative;
+  display: flex;
+  flex-grow: 1;
+  flex-direction: column;
+}
+
+/* Primary variant */
+.dropin-input--primary {
+  border: var(--shape-border-width-1) solid var(--color-neutral-600);
+}
+
+.dropin-input--primary:focus {
+  border-color: var(--color-neutral-800);
+  border-radius: var(--shape-border-radius-1);
+}
+
+div.dropin-input-container--primary .dropin-input--disabled {
+  border: var(--shape-border-width-1) solid var(--color-neutral-500);
+}
+
+.dropin-input-container--primary .dropin-input--error {
+  border: var(--shape-border-width-2) solid var(--color-alert-500);
+}
+
+.dropin-input-container--primary .dropin-input--success {
+  border: var(--shape-border-width-2) solid var(--color-positive-500);
+}
+
+/* Secondary variant */
+.dropin-input--secondary {
+  border: 0;
+  border-radius: 0;
+  border-top: var(--shape-border-width-1) solid transparent;
+  border-bottom: var(--shape-border-width-1) solid var(--color-neutral-600);
+}
+
+.dropin-input--secondary:focus {
+  border-top-left-radius: var(--shape-border-radius-1);
+  border-top-right-radius: var(--shape-border-radius-1);
+  border-bottom-color: var(--color-neutral-800);
+}
+
+/* Container Secondary */
+div.dropin-input-container--secondary .dropin-input--disabled {
+  border: 0;
+  border-radius: 0;
+  border-bottom: var(--shape-border-width-1) solid var(--color-neutral-500);
+}
+
+.dropin-input-container--secondary .dropin-input--error {
+  border: 0;
+  border-radius: 0;
+  border-bottom: var(--shape-border-width-2) solid var(--color-alert-500);
+}
+
+.dropin-input-container--secondary .dropin-input--success {
+  border: 0;
+  border-radius: 0;
+  border-bottom: var(--shape-border-width-2) solid var(--color-positive-500);
+}
+
+/* Size
+  Medium variant has a resulting height of 40px
+  Large variant has a resulting height of 48px
+  FloatingLabel variant has a resulting height of 56px in any variant
+*/
+.dropin-input--medium {
+  font: var(--type-body-2-default-font);
+  letter-spacing: var(--type-body-2-default-letter-spacing);
+  padding: 9px var(--spacing-small);
+}
+
+.dropin-input--medium ~ label {
+  font: var(--type-body-2-default-font);
+  letter-spacing: var(--type-body-2-default-letter-spacing);
+}
+
+.dropin-input--large {
+  font: var(--type-body-1-default-font);
+  letter-spacing: var(--type-body-1-default-letter-spacing);
+  padding: 11px var(--spacing-small);
+}
+
+.dropin-input--large ~ label {
+  font: var(--type-body-1-default-font);
+  letter-spacing: var(--type-body-1-default-letter-spacing);
+}
+
+/* Floating Label */
+.dropin-input__label--floating {
+  cursor: text;
+  color: var(--color-neutral-700);
+  padding-left: var(--spacing-small);
+  position: absolute;
+  pointer-events: none;
+  transform: translateY(-50%);
+  top: 50%;
+  transition: top 50ms ease-in, left 50ms ease-in, font-size 50ms ease-in;
+  z-index: 1;
+}
+
+.dropin-input__label--floating,
+.dropin-input--floating {
+  transition: all 0.2s;
+  touch-action: manipulation;
+}
+
+.dropin-input--medium.dropin-input--floating {
+  padding-top: 17px;
+  padding-bottom: 17px;
+}
+
+.dropin-input--medium.dropin-input--floating:focus,
+.dropin-input--medium.dropin-input--floating:not(:placeholder-shown) {
+  padding-top: 26px;
+}
+
+.dropin-input--large.dropin-input--floating {
+  padding-top: 15px;
+  padding-bottom: 15px;
+}
+
+.dropin-input--large.dropin-input--floating:focus,
+.dropin-input--large.dropin-input--floating:not(:placeholder-shown) {
+  padding-top: 22px;
+}
+
+.dropin-input--floating:focus,
+.dropin-input--floating:not(:placeholder-shown) {
+  padding-bottom: calc(var(--spacing-small) - var(--spacing-xsmall));
+}
+
+.dropin-input__label--floating--icon-left {
+  padding-left: calc(var(--icon-size) + (var(--spacing-small) * 2));
+}
+
+.dropin-input--floating:-webkit-autofill ~ .dropin-input__label--floating,
+.dropin-input-container--floating:focus-within .dropin-input__label--floating {
+  color: var(--color-neutral-800);
+  transform: translate(0.1em, -1.5em);
+  font: var(--type-details-caption-1-font);
+  letter-spacing: var(--type-details-caption-1-letter-spacing);
+}
+
+.dropin-input--floating:not(:placeholder-shown)
+  ~ .dropin-input__label--floating {
+  transform: translate(0.1em, -1.5em);
+  font: var(--type-details-caption-1-font);
+  letter-spacing: var(--type-details-caption-1-letter-spacing);
+}
+
+.dropin-input-container--disabled .dropin-icon,
+.dropin-input-container--disabled .dropin-input__label--floating {
+  color: var(--color-neutral-500);
+}
+
+.dropin-input--floating::-webkit-input-placeholder,
+.dropin-input--floating::placeholder {
+  opacity: 0;
+  transition: inherit;
+}
+
+.dropin-input--floating:focus::-webkit-input-placeholder,
+.dropin-input--floating:focus::placeholder {
+  opacity: 1;
+}
+
+.dropin-input__label--floating--error {
+  color: var(--color-alert-500);
+}
+
+/* Icon */
+.dropin-input--icon-right,
+.dropin-input--icon-left {
+  --icon-space: calc(var(--icon-size) + (var(--spacing-small) * 2));
+}
+
+.dropin-input--icon-right {
+  padding-right: var(--icon-space);
+}
+
+.dropin-input--icon-left {
+  padding-left: var(--icon-space);
+}
+
+.dropin-input__field-icon--left,
+.dropin-input__field-icon--right {
+  position: absolute;
+  z-index: 2;
+}
+
+.dropin-input__field-icon--left {
+  left: var(--spacing-small);
+}
+
+.dropin-input__field-icon--right {
+  right: var(--spacing-small);
+}
+
+.dropin-input__field-icon--error,
+.dropin-input__field-icon--success {
+  color: var(--color-neutral-100);
+  height: var(--icon-size);
+  width: var(--icon-size);
+}
+
+.dropin-input__field-icon--success {
+  color: var(--color-positive-500);
+}
+
+.dropin-input__field-icon--error {
+  color: var(--color-alert-500);
+}
+
+/* Medium (portrait tablets and large phones, 768px and up) */
+/* @media only screen and (min-width: 768px) { } */
+
+/* Large (landscape tablets, 1024px and up) */
+/* @media only screen and (min-width: 1024px) { } */
+
+/* XLarge (laptops/desktops, 1366px and up) */
+/* @media only screen and (min-width: 1366px) { } */
+
+/* XXlarge (large laptops and desktops, 1920px and up) */
+/* @media only screen and (min-width: 1920px) { } */