uikit-react-public 0.47.2 → 0.48.1

package/lib/components/ConfidentialInput/ConfidentialInput.stories.tsx

@@ -0,0 +1,51 @@
+import type { Meta, StoryObj } from '@storybook/react-vite';
+import ConfidentialInput from './ConfidentialInput';
+
+const meta = {
+  title: 'Components/ConfidentialInput',
+  component: ConfidentialInput,
+  parameters: {
+    layout: 'centered',
+  },
+  tags: ['autodocs'],
+  args: {
+    'aria-label': 'Account number',
+    defaultValue: '12345678',
+    maskFormat: '****1111',
+  },
+} satisfies Meta<typeof ConfidentialInput>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};
+
+export const Showable: Story = {
+  args: {
+    showable: true,
+  },
+};
+
+export const WithSeparators: Story = {
+  args: {
+    'aria-label': 'Sort code',
+    defaultValue: '123472',
+    maskFormat: '**-**-11',
+    showable: true,
+  },
+};
+
+export const FunctionMask: Story = {
+  args: {
+    maskFormat: (value) =>
+      `${'*'.repeat(Math.max(0, value.length - 2))}${value.slice(-2)}`,
+    showable: true,
+  },
+};
+
+export const MaskedWhenFocused: Story = {
+  args: {
+    visibleWhenFocused: false,
+  },
+};

package/lib/components/ConfidentialInput/ConfidentialInput.tsx

@@ -0,0 +1,280 @@
+import {
+  ChangeEvent,
+  FocusEvent,
+  forwardRef,
+  memo,
+  use,
+  useCallback,
+  useEffect,
+  useRef,
+  useState,
+} from 'react';
+import { css, cx } from '@emotion/css';
+import useTheme from '../../theme/useTheme';
+import Icon from '../Icon';
+import IconButton from '../IconButton';
+import Input, { InputProps } from '../Input';
+import { FieldContext } from '../Field';
+import marginsStyle from '../common/marginsStyle';
+
+export const NAME = 'ucl-uikit-confidential-input';
+
+export interface ConfidentialInputProps extends Omit<
+  InputProps,
+  'iconButton' | 'type'
+> {
+  maskFormat: string | ((value: string) => string);
+  showable?: boolean;
+  visibleWhenFocused?: boolean;
+}
+
+export type Ref = HTMLInputElement;
+
+const getStringValue = (
+  value: InputProps['value'] | InputProps['defaultValue']
+) => {
+  if (value === undefined || value === null) return '';
+  return Array.isArray(value) ? value.join(',') : String(value);
+};
+
+const applyMaskTemplate = (value: string, template: string) => {
+  const valueCharacters = Array.from(value);
+  let valueIndex = 0;
+  let maskedValue = '';
+
+  for (const templateCharacter of Array.from(template)) {
+    if (valueIndex >= valueCharacters.length) break;
+
+    if (templateCharacter === '1') {
+      maskedValue += valueCharacters[valueIndex];
+      valueIndex += 1;
+    } else if (templateCharacter === '*') {
+      maskedValue += '*';
+      valueIndex += 1;
+    } else {
+      maskedValue += templateCharacter;
+    }
+  }
+
+  return (
+    maskedValue + '*'.repeat(Math.max(0, valueCharacters.length - valueIndex))
+  );
+};
+
+const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
+  (
+    {
+      maskFormat,
+      showable = false,
+      visibleWhenFocused = true,
+      value,
+      defaultValue,
+      disabled,
+      icon,
+      iconPosition = 'left',
+      inputClassName,
+      className,
+      testId = NAME,
+      onChange,
+      onBlur,
+      onFocus,
+      m,
+      mv,
+      mh,
+      mt,
+      mb,
+      ml,
+      mr,
+      noMargins,
+      ...props
+    },
+    ref
+  ) => {
+    const [theme] = useTheme();
+    const { disabled: contextDisabled } = use(FieldContext);
+    const inputRef = useRef<HTMLInputElement>(null);
+    const [isShown, setIsShown] = useState(false);
+    const [isFocused, setIsFocused] = useState(false);
+    const [uncontrolledValue, setUncontrolledValue] = useState(() =>
+      getStringValue(defaultValue)
+    );
+    const resolvedDisabled = disabled ?? contextDisabled;
+    const valueIsPersistentlyShown = showable && isShown;
+    const valueIsVisible =
+      (visibleWhenFocused && isFocused) || valueIsPersistentlyShown;
+
+    const setInputRef = useCallback(
+      (element: HTMLInputElement | null) => {
+        inputRef.current = element;
+
+        if (typeof ref === 'function') {
+          ref(element);
+        } else if (ref) {
+          ref.current = element;
+        }
+      },
+      [ref]
+    );
+
+    useEffect(() => {
+      if (!showable) setIsShown(false);
+    }, [showable]);
+
+    useEffect(() => {
+      const input = inputRef.current;
+      const form = input?.form;
+      if (!input || !form || value !== undefined) 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);
+      };
+    }, [value]);
+
+    const stringValue =
+      value === undefined ? uncontrolledValue : getStringValue(value);
+    const maskedValue =
+      typeof maskFormat === 'function'
+        ? maskFormat(stringValue)
+        : applyMaskTemplate(stringValue, maskFormat);
+    const displayedMaskedValue = maskedValue.split('*').join('•');
+    const configuredMaskIsVisible =
+      !valueIsPersistentlyShown && !isFocused && stringValue.length > 0;
+
+    const wrapperStyle = cx(
+      NAME,
+      css`
+        position: relative;
+        display: block;
+      `,
+      marginsStyle({ m, mv, mh, mt, mb, ml, mr, noMargins }, theme),
+      className
+    );
+
+    const hiddenInputStyle = css`
+      color: transparent;
+      -webkit-text-fill-color: transparent;
+      caret-color: ${theme.colour.text.default};
+    `;
+
+    const { md } = theme.typography.body;
+    const maskStyle = css`
+      position: absolute;
+      top: 0;
+      bottom: 0;
+      left: ${
+        icon && iconPosition === 'left' ? theme.padding.p48 : theme.padding.p16
+      };
+      right: ${
+        showable && icon && iconPosition === 'right'
+          ? theme.padding.p80
+          : showable || (icon && iconPosition === 'right')
+            ? theme.padding.p48
+            : theme.padding.p16
+      };
+      display: flex;
+      align-items: center;
+      overflow: hidden;
+      color: ${
+        resolvedDisabled
+          ? 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);
+    };
+
+    const visibilityButton = showable ? (
+      <IconButton
+        type='button'
+        disabled={resolvedDisabled}
+        aria-label={
+          valueIsPersistentlyShown
+            ? 'Hide confidential value'
+            : 'Show confidential value'
+        }
+        aria-pressed={valueIsPersistentlyShown}
+        testId={`${testId}-visibility-toggle`}
+        onClick={() => setIsShown((shown) => !shown)}
+      >
+        {valueIsPersistentlyShown ? (
+          <Icon.EyeOff
+            aria-hidden='true'
+            testId={`${testId}-hide-icon`}
+          />
+        ) : (
+          <Icon.Eye
+            aria-hidden='true'
+            testId={`${testId}-show-icon`}
+          />
+        )}
+      </IconButton>
+    ) : undefined;
+
+    return (
+      <span className={wrapperStyle}>
+        <Input
+          {...props}
+          ref={setInputRef}
+          value={value}
+          defaultValue={defaultValue}
+          disabled={resolvedDisabled}
+          icon={icon}
+          iconPosition={iconPosition}
+          iconButton={visibilityButton}
+          inputClassName={cx(
+            configuredMaskIsVisible && hiddenInputStyle,
+            inputClassName
+          )}
+          testId={testId}
+          type={valueIsVisible ? 'text' : 'password'}
+          onChange={handleChange}
+          onFocus={handleFocus}
+          onBlur={handleBlur}
+        />
+        {configuredMaskIsVisible && (
+          <span
+            className={maskStyle}
+            data-testid={`${testId}-mask`}
+            aria-hidden='true'
+          >
+            {displayedMaskedValue}
+          </span>
+        )}
+      </span>
+    );
+  }
+);
+
+export default memo(ConfidentialInput);

package/lib/components/ConfidentialInput/Documentation.mdx

@@ -0,0 +1,70 @@
+import * as ConfidentialInputStories from './ConfidentialInput.stories';
+import {
+  Meta,
+  Title,
+  Subtitle,
+  Canvas,
+  Source,
+  ArgTypes,
+} from '@storybook/addon-docs/blocks';
+
+<Meta of={ConfidentialInputStories} />
+<Title />
+<Subtitle>An Input that masks confidential values</Subtitle>
+
+`ConfidentialInput` extends `Input` and preserves the original value for editing,
+change events, and form submission while displaying a masked value.
+
+<Canvas of={ConfidentialInputStories.Default} />
+
+## Usage
+
+The string mask is a simple template. `1` reveals the corresponding value
+character, `*` masks it with a `•`, and all other characters are displayed as
+separators. Asterisks returned by a formatter function are also displayed as
+bullets. Focusing the input temporarily reveals the original value for editing,
+and blurring restores the configured mask. When `showable` is `true`, the Eye
+control lets users keep the original value visible while the input is
+unfocused. Set `visibleWhenFocused` to `false` to use the browser's native
+password mask while editing; this keeps the caret aligned with the underlying
+value. The configured mask returns on blur.
+
+<Source
+  code={`<ConfidentialInput
+  defaultValue='12345678'
+  maskFormat='****1111'
+  showable
+  aria-label='Account number'
+/>`}
+/>
+
+A function can be supplied when the template syntax is not sufficient:
+
+<Source
+  code={`<ConfidentialInput
+  defaultValue='12345678'
+  maskFormat={(value) =>
+    \`\${'*'.repeat(Math.max(0, value.length - 2))}\${value.slice(-2)}\`
+  }
+/>`}
+/>
+
+## Props
+
+- `maskFormat`: **string | (value: string) => string** - Required mask template
+  or formatter.
+- `showable`: **boolean** - Adds a button that toggles the original value.
+  Defaults to `false`.
+- `visibleWhenFocused`: **boolean** - Reveals the original value while focused.
+  When `false`, the native password mask is shown while editing. Defaults to
+  `true`.
+- All `Input` props except `type` and `iconButton` are supported.
+
+<ArgTypes />
+
+## Examples
+
+<Canvas of={ConfidentialInputStories.Showable} />
+<Canvas of={ConfidentialInputStories.WithSeparators} />
+<Canvas of={ConfidentialInputStories.FunctionMask} />
+<Canvas of={ConfidentialInputStories.MaskedWhenFocused} />