uikit-react-public 0.48.0 → 0.49.0

package/lib/components/ConfidentialDisplayField/ConfidentialDisplayField.stories.tsx

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

package/lib/components/ConfidentialDisplayField/ConfidentialDisplayField.tsx

@@ -0,0 +1,103 @@
+import { forwardRef, memo, useEffect, useState } from 'react';
+import { css, cx } from '@emotion/css';
+import useTheme from '../../theme/useTheme';
+import DisplayField, { DisplayFieldProps } from '../DisplayField';
+import Icon from '../Icon';
+import IconButton from '../IconButton';
+import formatConfidentialValue, {
+  MaskFormat,
+} from '../common/formatConfidentialValue';
+import marginsStyle from '../common/marginsStyle';
+
+export const NAME = 'ucl-uikit-confidential-display-field';
+
+export interface ConfidentialDisplayFieldProps extends DisplayFieldProps {
+  maskFormat: MaskFormat;
+  showable?: boolean;
+}
+
+export type Ref = HTMLOutputElement;
+
+const ConfidentialDisplayField = forwardRef<Ref, ConfidentialDisplayFieldProps>(
+  (
+    {
+      value,
+      maskFormat,
+      showable = false,
+      testId = NAME,
+      className,
+      m,
+      mv,
+      mh,
+      mt,
+      mb,
+      ml,
+      mr,
+      noMargins,
+      ...props
+    },
+    ref
+  ) => {
+    const [theme] = useTheme();
+    const [isShown, setIsShown] = useState(false);
+    const stringValue = String(value);
+    const valueIsShown = showable && isShown;
+    const displayedValue = valueIsShown
+      ? stringValue
+      : formatConfidentialValue(stringValue, maskFormat);
+
+    useEffect(() => {
+      if (!showable) setIsShown(false);
+    }, [showable]);
+
+    const wrapperStyle = cx(
+      NAME,
+      css`
+        display: inline-flex;
+        align-items: center;
+        gap: ${theme.padding.p8};
+      `,
+      marginsStyle({ m, mv, mh, mt, mb, ml, mr, noMargins }, theme),
+      className
+    );
+
+    return (
+      <span className={wrapperStyle}>
+        <DisplayField
+          {...props}
+          ref={ref}
+          value={displayedValue}
+          testId={testId}
+          noMargins
+        />
+        {showable && (
+          <IconButton
+            type='button'
+            aria-label={
+              valueIsShown
+                ? 'Hide confidential value'
+                : 'Show confidential value'
+            }
+            aria-pressed={valueIsShown}
+            testId={`${testId}-visibility-toggle`}
+            onClick={() => setIsShown((shown) => !shown)}
+          >
+            {valueIsShown ? (
+              <Icon.EyeOff
+                aria-hidden='true'
+                testId={`${testId}-hide-icon`}
+              />
+            ) : (
+              <Icon.Eye
+                aria-hidden='true'
+                testId={`${testId}-show-icon`}
+              />
+            )}
+          </IconButton>
+        )}
+      </span>
+    );
+  }
+);
+
+export default memo(ConfidentialDisplayField);

package/lib/components/ConfidentialDisplayField/Documentation.mdx

@@ -0,0 +1,43 @@
+import * as ConfidentialDisplayFieldStories from './ConfidentialDisplayField.stories';
+import {
+  Meta,
+  Title,
+  Subtitle,
+  Canvas,
+  Source,
+  ArgTypes,
+} from '@storybook/addon-docs/blocks';
+
+<Meta of={ConfidentialDisplayFieldStories} />
+<Title />
+<Subtitle>A DisplayField that masks confidential values</Subtitle>
+
+`ConfidentialDisplayField` extends `DisplayField` with the same simple mask
+format used by `ConfidentialInput`. `1` reveals a value character, `*` masks it
+with a `•`, and other characters are displayed as separators.
+
+<Source
+  code={`<ConfidentialDisplayField
+  value='12345678'
+  maskFormat='******11'
+  showable
+/>`}
+/>
+
+## Props
+
+- `value`: **string | number** - The original value.
+- `maskFormat`: **string | (value: string) => string** - Required mask template
+  or formatter.
+- `showable`: **boolean** - Adds a button that toggles the original value.
+  Defaults to `false`.
+- All `DisplayField` props are supported.
+
+<ArgTypes />
+
+## Examples
+
+<Canvas of={ConfidentialDisplayFieldStories.Default} />
+<Canvas of={ConfidentialDisplayFieldStories.Showable} />
+<Canvas of={ConfidentialDisplayFieldStories.WithSeparators} />
+<Canvas of={ConfidentialDisplayFieldStories.FunctionMask} />

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

@@ -0,0 +1,125 @@
+import { createRef } from 'react';
+import { describe, expect, test } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { ThemeContextProvider } from '../../../theme/useTheme';
+import ConfidentialDisplayField from '../ConfidentialDisplayField';
+
+const renderDisplayField = (
+  props: React.ComponentProps<typeof ConfidentialDisplayField>
+) =>
+  render(
+    <ThemeContextProvider>
+      <ConfidentialDisplayField {...props} />
+    </ThemeContextProvider>
+  );
+
+describe('ConfidentialDisplayField', () => {
+  test('applies a string mask', () => {
+    renderDisplayField({
+      value: '12345678',
+      maskFormat: '******11',
+    });
+
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-display-field')
+    ).toHaveTextContent('••••••78');
+  });
+
+  test('applies a function mask', () => {
+    renderDisplayField({
+      value: 12345678,
+      maskFormat: (value) => `**** ending in ${value.slice(-2)}`,
+    });
+
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-display-field')
+    ).toHaveTextContent('•••• ending in 78');
+  });
+
+  test('does not add a visibility control by default', () => {
+    renderDisplayField({
+      value: '12345678',
+      maskFormat: '******11',
+    });
+
+    expect(
+      screen.queryByRole('button', { name: 'Show confidential value' })
+    ).not.toBeInTheDocument();
+  });
+
+  test('toggles the original value', async () => {
+    const user = userEvent.setup();
+    renderDisplayField({
+      value: '12345678',
+      maskFormat: '******11',
+      showable: true,
+    });
+
+    const output = screen.getByTestId('ucl-uikit-confidential-display-field');
+    await user.click(
+      screen.getByRole('button', { name: 'Show confidential value' })
+    );
+
+    expect(output).toHaveTextContent('12345678');
+    expect(
+      screen.getByRole('button', { name: 'Hide confidential value' })
+    ).toHaveAttribute('aria-pressed', 'true');
+
+    await user.click(
+      screen.getByRole('button', { name: 'Hide confidential value' })
+    );
+    expect(output).toHaveTextContent('••••••78');
+  });
+
+  test('forwards its ref to the output', () => {
+    const ref = createRef<HTMLOutputElement>();
+    render(
+      <ThemeContextProvider>
+        <ConfidentialDisplayField
+          ref={ref}
+          value='12345678'
+          maskFormat='******11'
+        />
+      </ThemeContextProvider>
+    );
+
+    expect(ref.current).toBe(
+      screen.getByTestId('ucl-uikit-confidential-display-field')
+    );
+  });
+
+  test('hides the value when showable changes to false', async () => {
+    const user = userEvent.setup();
+    const { rerender } = render(
+      <ThemeContextProvider>
+        <ConfidentialDisplayField
+          value='12345678'
+          maskFormat='******11'
+          showable
+        />
+      </ThemeContextProvider>
+    );
+
+    await user.click(
+      screen.getByRole('button', { name: 'Show confidential value' })
+    );
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-display-field')
+    ).toHaveTextContent('12345678');
+
+    rerender(
+      <ThemeContextProvider>
+        <ConfidentialDisplayField
+          value='12345678'
+          maskFormat='******11'
+          showable={false}
+        />
+      </ThemeContextProvider>
+    );
+
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-display-field')
+    ).toHaveTextContent('••••••78');
+  });
+});

package/lib/components/ConfidentialDisplayField/index.ts

@@ -0,0 +1,2 @@
+export { default } from './ConfidentialDisplayField';
+export type { ConfidentialDisplayFieldProps } from './ConfidentialDisplayField';

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

@@ -43,3 +43,9 @@ export const FunctionMask: Story = {
     showable: true,
   },
 };
+
+export const MaskedWhenFocused: Story = {
+  args: {
+    visibleWhenFocused: false,
+  },
+};

package/lib/components/ConfidentialInput/ConfidentialInput.tsx

@@ -16,6 +16,9 @@ import IconButton from '../IconButton';
 import Input, { InputProps } from '../Input';
 import { FieldContext } from '../Field';
 import marginsStyle from '../common/marginsStyle';
+import formatConfidentialValue, {
+  MaskFormat,
+} from '../common/formatConfidentialValue';
 
 export const NAME = 'ucl-uikit-confidential-input';
 
@@ -23,8 +26,9 @@ export interface ConfidentialInputProps extends Omit<
   InputProps,
   'iconButton' | 'type'
 > {
-  maskFormat: string | ((value: string) => string);
+  maskFormat: MaskFormat;
   showable?: boolean;
+  visibleWhenFocused?: boolean;
 }
 
 export type Ref = HTMLInputElement;
@@ -36,35 +40,12 @@ const getStringValue = (
   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,
@@ -97,7 +78,9 @@ const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
       getStringValue(defaultValue)
     );
     const resolvedDisabled = disabled ?? contextDisabled;
-    const valueIsShown = showable && isShown;
+    const valueIsPersistentlyShown = showable && isShown;
+    const valueIsVisible =
+      (visibleWhenFocused && isFocused) || valueIsPersistentlyShown;
 
     const setInputRef = useCallback(
       (element: HTMLInputElement | null) => {
@@ -138,12 +121,12 @@ const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
 
     const stringValue =
       value === undefined ? uncontrolledValue : getStringValue(value);
-    const maskedValue =
-      typeof maskFormat === 'function'
-        ? maskFormat(stringValue)
-        : applyMaskTemplate(stringValue, maskFormat);
-    const visuallyHidden =
-      !valueIsShown && !isFocused && stringValue.length > 0;
+    const displayedMaskedValue = formatConfidentialValue(
+      stringValue,
+      maskFormat
+    );
+    const configuredMaskIsVisible =
+      !valueIsPersistentlyShown && !isFocused && stringValue.length > 0;
 
     const wrapperStyle = cx(
       NAME,
@@ -215,13 +198,15 @@ const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
         type='button'
         disabled={resolvedDisabled}
         aria-label={
-          valueIsShown ? 'Hide confidential value' : 'Show confidential value'
+          valueIsPersistentlyShown
+            ? 'Hide confidential value'
+            : 'Show confidential value'
         }
-        aria-pressed={valueIsShown}
+        aria-pressed={valueIsPersistentlyShown}
         testId={`${testId}-visibility-toggle`}
         onClick={() => setIsShown((shown) => !shown)}
       >
-        {valueIsShown ? (
+        {valueIsPersistentlyShown ? (
           <Icon.EyeOff
             aria-hidden='true'
             testId={`${testId}-hide-icon`}
@@ -247,22 +232,22 @@ const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
           iconPosition={iconPosition}
           iconButton={visibilityButton}
           inputClassName={cx(
-            visuallyHidden && hiddenInputStyle,
+            configuredMaskIsVisible && hiddenInputStyle,
             inputClassName
           )}
           testId={testId}
-          type={valueIsShown ? 'text' : 'password'}
+          type={valueIsVisible ? 'text' : 'password'}
           onChange={handleChange}
           onFocus={handleFocus}
           onBlur={handleBlur}
         />
-        {visuallyHidden && (
+        {configuredMaskIsVisible && (
           <span
             className={maskStyle}
             data-testid={`${testId}-mask`}
             aria-hidden='true'
           >
-            {maskedValue}
+            {displayedMaskedValue}
           </span>
         )}
       </span>

package/lib/components/ConfidentialInput/Documentation.mdx

@@ -20,10 +20,14 @@ change events, and form submission while displaying a masked value.
 ## Usage
 
 The string mask is a simple template. `1` reveals the corresponding value
-character, `*` masks it, and all other characters are displayed as separators.
-The configured mask is displayed while the input is unfocused. While editing,
-the native password mask is used so the caret and selection remain aligned with
-the underlying 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
@@ -51,6 +55,9 @@ A function can be supplied when the template syntax is not sufficient:
   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 />
@@ -60,3 +67,4 @@ A function can be supplied when the template syntax is not sufficient:
 <Canvas of={ConfidentialInputStories.Showable} />
 <Canvas of={ConfidentialInputStories.WithSeparators} />
 <Canvas of={ConfidentialInputStories.FunctionMask} />
+<Canvas of={ConfidentialInputStories.MaskedWhenFocused} />

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

@@ -27,7 +27,7 @@ describe('ConfidentialInput', () => {
     );
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('1234****');
+    ).toHaveTextContent('1234••••');
   });
 
   test('supports separators and masks characters beyond the template', () => {
@@ -39,19 +39,19 @@ describe('ConfidentialInput', () => {
 
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('**-**-72*');
+    ).toHaveTextContent('••-••-72•');
   });
 
   test('applies a function mask', () => {
     renderInput({
-      maskFormat: (value) => `ending in ${value.slice(-2)}`,
+      maskFormat: (value) => `**** ending in ${value.slice(-2)}`,
       value: '12345678',
       onChange: () => {},
     });
 
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('ending in 78');
+    ).toHaveTextContent('•••• ending in 78');
   });
 
   test('does not add a visibility control by default', () => {
@@ -73,7 +73,9 @@ describe('ConfidentialInput', () => {
       showable: true,
     });
 
-    const input = screen.getByTestId('ucl-uikit-confidential-input');
+    const input = screen.getByTestId(
+      'ucl-uikit-confidential-input'
+    ) as HTMLInputElement;
     const showButton = screen.getByRole('button', {
       name: 'Show confidential value',
     });
@@ -109,6 +111,7 @@ describe('ConfidentialInput', () => {
     await user.type(input, '1234');
 
     expect(input).toHaveValue('1234');
+    expect(input).toHaveAttribute('type', 'text');
     expect(
       screen.queryByTestId('ucl-uikit-confidential-input-mask')
     ).not.toBeInTheDocument();
@@ -117,7 +120,7 @@ describe('ConfidentialInput', () => {
 
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('****');
+    ).toHaveTextContent('••••');
     expect(onChange).toHaveBeenLastCalledWith(expect.objectContaining({}));
     expect(onChange.mock.lastCall?.[0].target.value).toBe('1234');
   });
@@ -174,11 +177,41 @@ describe('ConfidentialInput', () => {
     });
   });
 
-  test('uses native password rendering while editing formatted values', async () => {
+  test('shows the raw value while editing a non-showable value', async () => {
+    const user = userEvent.setup();
+    renderInput({
+      maskFormat: '**-**-11',
+      defaultValue: '123472',
+    });
+
+    const input = screen.getByTestId(
+      'ucl-uikit-confidential-input'
+    ) as HTMLInputElement;
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-input-mask')
+    ).toHaveTextContent('••-••-72');
+
+    await user.click(input);
+
+    expect(input).toHaveAttribute('type', 'text');
+    expect(input).toHaveValue('123472');
+    expect(
+      screen.queryByTestId('ucl-uikit-confidential-input-mask')
+    ).not.toBeInTheDocument();
+
+    await user.tab();
+
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-input-mask')
+    ).toHaveTextContent('••-••-72');
+  });
+
+  test('uses native password masking when visibleWhenFocused is false', async () => {
     const user = userEvent.setup();
     renderInput({
       maskFormat: '**-**-11',
       defaultValue: '123472',
+      visibleWhenFocused: false,
     });
 
     const input = screen.getByTestId(
@@ -186,7 +219,7 @@ describe('ConfidentialInput', () => {
     ) as HTMLInputElement;
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('**-**-72');
+    ).toHaveTextContent('••-••-72');
 
     await user.click(input);
 
@@ -201,7 +234,41 @@ describe('ConfidentialInput', () => {
 
     expect(
       screen.getByTestId('ucl-uikit-confidential-input-mask')
-    ).toHaveTextContent('**-**-72');
+    ).toHaveTextContent('••-••-72');
+  });
+
+  test('shows the raw value while editing a showable value', async () => {
+    const user = userEvent.setup();
+    renderInput({
+      maskFormat: '**-**-11',
+      defaultValue: '123472',
+      showable: true,
+    });
+
+    const input = screen.getByTestId(
+      'ucl-uikit-confidential-input'
+    ) as HTMLInputElement;
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-input-mask')
+    ).toHaveTextContent('••-••-72');
+
+    await user.click(input);
+
+    expect(input).toHaveAttribute('type', 'text');
+    expect(
+      screen.queryByTestId('ucl-uikit-confidential-input-mask')
+    ).not.toBeInTheDocument();
+    expect(
+      screen.getByRole('button', { name: 'Show confidential value' })
+    ).toHaveAttribute('aria-pressed', 'false');
+    input.setSelectionRange(4, 4);
+    expect(input.selectionStart).toBe(4);
+
+    await user.tab();
+
+    expect(
+      screen.getByTestId('ucl-uikit-confidential-input-mask')
+    ).toHaveTextContent('••-••-72');
   });
 
   test('supports a right icon alongside the visibility control', () => {

package/lib/components/DisplayField/DisplayField.stories.tsx

@@ -0,0 +1,26 @@
+import type { Meta, StoryObj } from '@storybook/react-vite';
+import DisplayField from './DisplayField';
+
+const meta = {
+  title: 'Components/DisplayField',
+  component: DisplayField,
+  parameters: {
+    layout: 'centered',
+  },
+  tags: ['autodocs'],
+  args: {
+    value: 'Personal savings',
+  },
+} satisfies Meta<typeof DisplayField>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Text: Story = {};
+
+export const Number: Story = {
+  args: {
+    value: 12345678,
+  },
+};