uikit-react-public 0.48.1 → 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.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,7 +26,7 @@ export interface ConfidentialInputProps extends Omit<
   InputProps,
   'iconButton' | 'type'
 > {
-  maskFormat: string | ((value: string) => string);
+  maskFormat: MaskFormat;
   showable?: boolean;
   visibleWhenFocused?: boolean;
 }
@@ -37,30 +40,6 @@ 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>(
   (
     {
@@ -142,11 +121,10 @@ const ConfidentialInput = forwardRef<Ref, ConfidentialInputProps>(
 
     const stringValue =
       value === undefined ? uncontrolledValue : getStringValue(value);
-    const maskedValue =
-      typeof maskFormat === 'function'
-        ? maskFormat(stringValue)
-        : applyMaskTemplate(stringValue, maskFormat);
-    const displayedMaskedValue = maskedValue.split('*').join('•');
+    const displayedMaskedValue = formatConfidentialValue(
+      stringValue,
+      maskFormat
+    );
     const configuredMaskIsVisible =
       !valueIsPersistentlyShown && !isFocused && stringValue.length > 0;
 

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,
+  },
+};

package/lib/components/DisplayField/DisplayField.tsx

@@ -0,0 +1,56 @@
+import { forwardRef, memo, OutputHTMLAttributes, use } from 'react';
+import { css, cx } from '@emotion/css';
+import useTheme from '../../theme/useTheme';
+import { FieldContext } from '../Field';
+import marginsStyle, { MarginProps } from '../common/marginsStyle';
+
+export const NAME = 'ucl-uikit-display-field';
+
+export interface DisplayFieldBaseProps extends Omit<
+  OutputHTMLAttributes<HTMLOutputElement>,
+  'children' | 'value'
+> {
+  value: string | number;
+  testId?: string;
+}
+
+export type DisplayFieldProps = DisplayFieldBaseProps & MarginProps;
+
+export type Ref = HTMLOutputElement;
+
+const DisplayField = forwardRef<Ref, DisplayFieldProps>(
+  ({ value, testId = NAME, className, ...props }, ref) => {
+    const [theme] = useTheme();
+    const { id: contextId } = use(FieldContext);
+    const id = props.id ?? contextId;
+    const { md } = theme.typography.body;
+
+    const baseStyle = css`
+      display: block;
+      min-height: 24px;
+      color: ${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}%;
+      overflow-wrap: anywhere;
+    `;
+
+    const style = cx(NAME, baseStyle, marginsStyle(props, theme), className);
+
+    return (
+      <output
+        {...props}
+        ref={ref}
+        id={id}
+        className={style}
+        data-testid={testId}
+      >
+        {value}
+      </output>
+    );
+  }
+);
+
+export default memo(DisplayField);

package/lib/components/DisplayField/Documentation.mdx

@@ -0,0 +1,35 @@
+import * as DisplayFieldStories from './DisplayField.stories';
+import {
+  Meta,
+  Title,
+  Subtitle,
+  Canvas,
+  Source,
+  ArgTypes,
+} from '@storybook/addon-docs/blocks';
+
+<Meta of={DisplayFieldStories} />
+<Title />
+<Subtitle>A read-only field for displaying a single value</Subtitle>
+
+`DisplayField` renders a semantic HTML `<output>` element. Use it with `Label`
+to display a record in the same field structure used by editable forms.
+
+<Source
+  code={`<Field>
+  <Label>Account name</Label>
+  <DisplayField value='Personal savings' />
+</Field>`}
+/>
+
+## Props
+
+- `value`: **string | number** - The value to display.
+- All standard HTML `<output>` props are supported.
+
+<ArgTypes />
+
+## Examples
+
+<Canvas of={DisplayFieldStories.Text} />
+<Canvas of={DisplayFieldStories.Number} />

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

@@ -0,0 +1,61 @@
+import { createRef } from 'react';
+import { describe, expect, test } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import { ThemeContextProvider } from '../../../theme/useTheme';
+import DisplayField from '../DisplayField';
+import Field from '../../Field';
+import Label from '../../Label';
+
+const renderDisplayField = (props: React.ComponentProps<typeof DisplayField>) =>
+  render(
+    <ThemeContextProvider>
+      <DisplayField {...props} />
+    </ThemeContextProvider>
+  );
+
+describe('DisplayField', () => {
+  test('displays a text value', () => {
+    renderDisplayField({ value: 'Personal savings' });
+
+    expect(screen.getByTestId('ucl-uikit-display-field')).toHaveTextContent(
+      'Personal savings'
+    );
+  });
+
+  test('displays a numeric value', () => {
+    renderDisplayField({ value: 12345678 });
+
+    expect(screen.getByTestId('ucl-uikit-display-field')).toHaveTextContent(
+      '12345678'
+    );
+  });
+
+  test('shares the Field id with its Label', () => {
+    render(
+      <ThemeContextProvider>
+        <Field>
+          <Label>Account name</Label>
+          <DisplayField value='Personal savings' />
+        </Field>
+      </ThemeContextProvider>
+    );
+
+    const label = screen.getByText('Account name');
+    const output = screen.getByTestId('ucl-uikit-display-field');
+    expect(label).toHaveAttribute('for', output.id);
+  });
+
+  test('forwards its ref to the output', () => {
+    const ref = createRef<HTMLOutputElement>();
+    render(
+      <ThemeContextProvider>
+        <DisplayField
+          ref={ref}
+          value='Personal savings'
+        />
+      </ThemeContextProvider>
+    );
+
+    expect(ref.current).toBe(screen.getByTestId('ucl-uikit-display-field'));
+  });
+});

package/lib/components/DisplayField/index.ts

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

package/lib/components/common/formatConfidentialValue.ts

@@ -0,0 +1,36 @@
+export type MaskFormat = string | ((value: string) => string);
+
+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 formatConfidentialValue = (value: string, maskFormat: MaskFormat) => {
+  const maskedValue =
+    typeof maskFormat === 'function'
+      ? maskFormat(value)
+      : applyMaskTemplate(value, maskFormat);
+
+  return maskedValue.split('*').join('•');
+};
+
+export default formatConfidentialValue;

package/lib/components/index.ts

@@ -7,6 +7,12 @@ export type { InputProps } from './Input';
 export { default as ConfidentialInput } from './ConfidentialInput';
 export type { ConfidentialInputProps } from './ConfidentialInput';
 
+export { default as DisplayField } from './DisplayField';
+export type { DisplayFieldProps } from './DisplayField';
+
+export { default as ConfidentialDisplayField } from './ConfidentialDisplayField';
+export type { ConfidentialDisplayFieldProps } from './ConfidentialDisplayField';
+
 export { default as Link } from './Link';
 export type { LinkProps } from './Link';
 

package/package.json

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