uikit-react-public 0.49.0 → 0.49.1

package/lib/components/Input/Input.tsx

@@ -1,8 +1,14 @@
 import {
+  ChangeEvent,
+  FocusEvent,
   memo,
   InputHTMLAttributes,
   forwardRef,
   use,
+  useCallback,
+  useEffect,
+  useRef,
+  useState,
   ReactElement,
 } from 'react';
 import useTheme from '../../theme/useTheme';
@@ -11,6 +17,9 @@ import marginsStyle, { MarginProps } from '../common/marginsStyle';
 import { FieldContext } from '../Field';
 import { IconProps } from '../Icon';
 import { IconButtonProps } from '../IconButton/IconButton';
+import formatDisplayValue, {
+  DisplayValueFormat,
+} from '../common/formatDisplayValue';
 
 export const NAME = 'ucl-uikit-input';
 export const INPUT_NAME = 'ucl-uikit-input__input';
@@ -20,6 +29,7 @@ export interface InputBaseProps extends InputHTMLAttributes<HTMLInputElement> {
   iconPosition?: 'left' | 'right';
   iconButton?: ReactElement<IconButtonProps>;
   inputClassName?: string;
+  format?: DisplayValueFormat;
   testId?: string;
 }
 
@@ -35,17 +45,73 @@ const Input = forwardRef<Ref, InputProps>(
       iconPosition = 'left',
       iconButton,
       inputClassName,
+      format,
       className,
+      value,
+      defaultValue,
+      onChange,
+      onFocus,
+      onBlur,
       ...props
     },
-    ref
+    forwardedRef
   ) => {
     const [theme] = useTheme();
     const { md } = theme.typography.body;
+    const inputRef = useRef<HTMLInputElement>(null);
+    const [isFocused, setIsFocused] = useState(false);
+    const [uncontrolledValue, setUncontrolledValue] = useState(() => {
+      if (defaultValue === undefined || defaultValue === null) return '';
+      return Array.isArray(defaultValue)
+        ? defaultValue.join(',')
+        : String(defaultValue);
+    });
 
     const { disabled: contextDisabled, id: contextId } = use(FieldContext);
     const disabled = props.disabled ?? contextDisabled;
     const id = props.id ?? contextId;
+    const stringValue =
+      value === undefined
+        ? uncontrolledValue
+        : Array.isArray(value)
+          ? value.join(',')
+          : String(value);
+    const formattedValue = formatDisplayValue(stringValue, format);
+    const formattedValueIsVisible =
+      Boolean(format) && !isFocused && stringValue.length > 0;
+
+    const setInputRef = useCallback(
+      (element: HTMLInputElement | null) => {
+        inputRef.current = element;
+
+        if (typeof forwardedRef === 'function') {
+          forwardedRef(element);
+        } else if (forwardedRef) {
+          forwardedRef.current = element;
+        }
+      },
+      [forwardedRef]
+    );
+
+    useEffect(() => {
+      const input = inputRef.current;
+      const form = input?.form;
+      if (!input || !form || value !== undefined || !format) return;
+
+      let resetTimeout: ReturnType<typeof setTimeout> | undefined;
+      const handleReset = () => {
+        if (resetTimeout) clearTimeout(resetTimeout);
+        resetTimeout = setTimeout(() => {
+          setUncontrolledValue(input.value);
+        });
+      };
+
+      form.addEventListener('reset', handleReset);
+      return () => {
+        form.removeEventListener('reset', handleReset);
+        if (resetTimeout) clearTimeout(resetTimeout);
+      };
+    }, [format, value]);
 
     const inputBaseStyle = css`
       height: 48px;
@@ -92,6 +158,11 @@ const Input = forwardRef<Ref, InputProps>(
       padding-right: ${theme.padding.p80};
     `;
 
+    const formattedInputStyle = css`
+      color: transparent;
+      -webkit-text-fill-color: transparent;
+    `;
+
     const hasRightIconAndButton = Boolean(
       icon && iconPosition === 'right' && iconButton
     );
@@ -106,6 +177,7 @@ const Input = forwardRef<Ref, InputProps>(
         !hasRightIconAndButton &&
         padRightStyle,
       hasRightIconAndButton && padRightForTwoControlsStyle,
+      formattedValueIsVisible && formattedInputStyle,
       inputClassName
     );
 
@@ -150,16 +222,76 @@ const Input = forwardRef<Ref, InputProps>(
 
     const iconButtonStyle = cx(iconWrapperBaseStyle, rightPositionStyle);
 
+    const formattedValueStyle = css`
+      position: absolute;
+      top: 0;
+      bottom: 0;
+      left: ${
+        icon && iconPosition === 'left' ? theme.padding.p48 : theme.padding.p16
+      };
+      right: ${
+        hasRightIconAndButton
+          ? theme.padding.p80
+          : (icon && iconPosition === 'right') || iconButton
+            ? theme.padding.p48
+            : theme.padding.p16
+      };
+      display: flex;
+      align-items: center;
+      overflow: hidden;
+      color: ${
+        disabled ? theme.colour.text.disabled : theme.colour.text.default
+      };
+      font-family: ${md.fontFamily};
+      font-feature-settings: ${md.fontSettings};
+      font-size: ${md.fontSize}px;
+      font-weight: ${md.fontWeight};
+      line-height: ${md.lineHeight}%;
+      pointer-events: none;
+      white-space: nowrap;
+    `;
+
+    const handleChange = (event: ChangeEvent<HTMLInputElement>) => {
+      if (value === undefined) {
+        setUncontrolledValue(event.target.value);
+      }
+      onChange?.(event);
+    };
+
+    const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
+      setIsFocused(true);
+      onFocus?.(event);
+    };
+
+    const handleBlur = (event: FocusEvent<HTMLInputElement>) => {
+      setIsFocused(false);
+      onBlur?.(event);
+    };
+
     return (
       <span className={wrapperClass}>
         <input
-          ref={ref}
+          ref={setInputRef}
           id={id}
           className={inputStyle}
           data-testid={testId}
           disabled={disabled}
+          value={value}
+          defaultValue={defaultValue}
+          onChange={handleChange}
+          onFocus={handleFocus}
+          onBlur={handleBlur}
           {...props}
         />
+        {formattedValueIsVisible && (
+          <span
+            className={formattedValueStyle}
+            data-testid={`${testId}-formatted-value`}
+            aria-hidden='true'
+          >
+            {formattedValue}
+          </span>
+        )}
         {icon && <span className={iconWrapperStyle}>{icon}</span>}
         {iconButton && <span className={iconButtonStyle}>{iconButton}</span>}
       </span>

package/lib/components/Input/__tests__/Input.test.tsx

@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'vitest';
-import { render, screen } from '@testing-library/react';
+import { render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import Input from '../Input';
 import { ThemeContextProvider } from '../../../theme/useTheme';
@@ -139,4 +139,99 @@ describe('Input', () => {
     expect(iconWrapper).toHaveStyle({ right: '48px' });
     expect(buttonWrapper).toHaveStyle({ right: '16px' });
   });
+
+  test('formats an uncontrolled value while blurred', async () => {
+    const user = userEvent.setup();
+    render(
+      <ThemeContextProvider>
+        <Input
+          defaultValue='112233'
+          format='##-##-##'
+        />
+      </ThemeContextProvider>
+    );
+
+    const input = screen.getByTestId('ucl-uikit-input');
+    expect(input).toHaveValue('112233');
+    expect(
+      screen.getByTestId('ucl-uikit-input-formatted-value')
+    ).toHaveTextContent('11-22-33');
+
+    await user.click(input);
+    expect(
+      screen.queryByTestId('ucl-uikit-input-formatted-value')
+    ).not.toBeInTheDocument();
+
+    await user.clear(input);
+    await user.type(input, '445566');
+    await user.tab();
+
+    expect(input).toHaveValue('445566');
+    expect(
+      screen.getByTestId('ucl-uikit-input-formatted-value')
+    ).toHaveTextContent('44-55-66');
+  });
+
+  test('formats a value with a function', () => {
+    render(
+      <ThemeContextProvider>
+        <Input
+          value='1234.5'
+          format={(value) => `£${value}`}
+          onChange={() => {}}
+        />
+      </ThemeContextProvider>
+    );
+
+    expect(
+      screen.getByTestId('ucl-uikit-input-formatted-value')
+    ).toHaveTextContent('£1234.5');
+  });
+
+  test('submits the raw value when formatted', () => {
+    render(
+      <ThemeContextProvider>
+        <form data-testid='form'>
+          <Input
+            name='sortCode'
+            defaultValue='112233'
+            format='##-##-##'
+          />
+        </form>
+      </ThemeContextProvider>
+    );
+
+    const form = screen.getByTestId('form') as HTMLFormElement;
+    expect(new FormData(form).get('sortCode')).toBe('112233');
+  });
+
+  test('resynchronises a formatted value after form reset', async () => {
+    const user = userEvent.setup();
+    render(
+      <ThemeContextProvider>
+        <form data-testid='form'>
+          <Input
+            defaultValue='112233'
+            format='##-##-##'
+          />
+        </form>
+      </ThemeContextProvider>
+    );
+
+    const input = screen.getByTestId('ucl-uikit-input');
+    const form = screen.getByTestId('form') as HTMLFormElement;
+    await user.click(input);
+    await user.clear(input);
+    await user.type(input, '445566');
+    await user.tab();
+
+    form.reset();
+
+    await waitFor(() => {
+      expect(input).toHaveValue('112233');
+      expect(
+        screen.getByTestId('ucl-uikit-input-formatted-value')
+      ).toHaveTextContent('11-22-33');
+    });
+  });
 });

package/lib/components/common/formatConfidentialValue.ts

@@ -8,7 +8,7 @@ const applyMaskTemplate = (value: string, template: string) => {
   for (const templateCharacter of Array.from(template)) {
     if (valueIndex >= valueCharacters.length) break;
 
-    if (templateCharacter === '1') {
+    if (templateCharacter === '#') {
       maskedValue += valueCharacters[valueIndex];
       valueIndex += 1;
     } else if (templateCharacter === '*') {

package/lib/components/common/formatDisplayValue.ts

@@ -0,0 +1,29 @@
+export type DisplayValueFormat = string | ((value: string) => string);
+
+const applyFormatTemplate = (value: string, template: string) => {
+  const valueCharacters = Array.from(value);
+  let valueIndex = 0;
+  let formattedValue = '';
+
+  for (const templateCharacter of Array.from(template)) {
+    if (valueIndex >= valueCharacters.length) break;
+
+    if (templateCharacter === '#') {
+      formattedValue += valueCharacters[valueIndex];
+      valueIndex += 1;
+    } else {
+      formattedValue += templateCharacter;
+    }
+  }
+
+  return formattedValue + valueCharacters.slice(valueIndex).join('');
+};
+
+const formatDisplayValue = (value: string, format?: DisplayValueFormat) => {
+  if (!format) return value;
+  return typeof format === 'function'
+    ? format(value)
+    : applyFormatTemplate(value, format);
+};
+
+export default formatDisplayValue;

package/package.json

@@ -2,7 +2,7 @@
   "name": "uikit-react-public",
   "private": false,
   "license": "UNLICENSED",
-  "version": "0.49.0",
+  "version": "0.49.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",