@transferwise/components 0.0.0-experimental-91bc693 → 0.0.0-experimental-c023984

package/src/inputs/SelectInput.story.tsx

@@ -322,6 +322,26 @@ export const Advanced: Story<Month> = {
   },
 };
 
+export const ManyItems: Story<string, true> = {
+  args: {
+    multiple: true,
+    items: Array.from({ length: 1000 }, (_, index) => ({
+      type: 'option',
+      value: String(index + 1),
+    })),
+    renderValue: (value, withinTrigger) =>
+      withinTrigger ? (
+        value
+      ) : (
+        <SelectInputOptionContent
+          title={value}
+          description={Number(value) % 10 === 0 ? 'Divisible by 10' : undefined}
+        />
+      ),
+    filterable: true,
+  },
+};
+
 export const WithinDrawer: Story<Currency> = {
   args: CurrenciesArgs,
   decorators: [

package/src/inputs/SelectInput.tsx

@@ -6,6 +6,7 @@ import {
   createContext,
   forwardRef,
   useContext,
+  useDeferredValue,
   useEffect,
   useId,
   useMemo,
@@ -13,6 +14,7 @@ import {
   useState,
 } from 'react';
 import { useIntl } from 'react-intl';
+import { Virtualizer } from 'virtua';
 
 import { useEffectEvent } from '../common/hooks/useEffectEvent';
 import { useScreenSize } from '../common/hooks/useScreenSize';
@@ -29,6 +31,8 @@ import { InputGroup } from './InputGroup';
 import { SearchInput } from './SearchInput';
 import messages from './SelectInput.messages';
 
+const MAX_ITEMS_WITHOUT_VIRTUALIZATION = 50;
+
 function searchableString(value: string) {
   return value.trim().replace(/\s+/gu, ' ').normalize('NFKC').toLowerCase();
 }
@@ -40,7 +44,7 @@ function inferSearchableStrings(value: unknown) {
 
   if (typeof value === 'object' && value != null) {
     return Object.values(value)
-      .filter((innerValue): innerValue is string => typeof innerValue === 'string')
+      .filter((innerValue) => typeof innerValue === 'string')
       .map((innerValue) => searchableString(innerValue));
   }
 
@@ -89,6 +93,11 @@ function dedupeSelectInputOptionItem<T>(
   return { ...item, value: undefined };
 }
 
+/**
+ * Sets the `value` of duplicate option items to `undefined`, hiding them when
+ * rendered. Indexes are kept intact within groups to preserve the active item
+ * between filter changes when possible.
+ */
 function dedupeSelectInputItems<T>(
   items: readonly SelectInputItem<T>[],
 ): SelectInputItem<T | undefined>[] {
@@ -112,20 +121,23 @@ function dedupeSelectInputItems<T>(
   });
 }
 
-function filterSelectInputOptionItem<T>(item: SelectInputOptionItem<T>, needle: string) {
+function selectInputOptionItemIncludesNeedle<T>(item: SelectInputOptionItem<T>, needle: string) {
   return inferSearchableStrings(item.filterMatchers ?? item.value).some((haystack) =>
     haystack.includes(needle),
   );
 }
 
-function filterSelectInputItems<T>(items: readonly SelectInputItem<T>[], needle: string) {
+function filterSelectInputItems<T>(
+  items: readonly SelectInputItem<T>[],
+  predicate: (item: SelectInputOptionItem<T>) => boolean,
+) {
   return items.filter((item) => {
     switch (item.type) {
       case 'option': {
-        return filterSelectInputOptionItem(item, needle);
+        return predicate(item);
       }
       case 'group': {
-        return item.options.some((option) => filterSelectInputOptionItem(option, needle));
+        return item.options.some((option) => predicate(option));
       }
       default:
     }
@@ -271,12 +283,15 @@ export function SelectInput<T = string, M extends boolean = false>({
   }, [handleClose, open]);
 
   const [filterQuery, _setFilterQuery] = useState('');
+  const deferredFilterQuery = useDeferredValue(filterQuery);
   const setFilterQuery = useEffectEvent((query: string) => {
     _setFilterQuery(query);
-    onFilterChange({
-      query,
-      queryNormalized: query ? searchableString(query) : null,
-    });
+    if (query !== filterQuery) {
+      onFilterChange({
+        query,
+        queryNormalized: query ? searchableString(query) : null,
+      });
+    }
   });
 
   const triggerRef = useRef<HTMLButtonElement | null>(null);
@@ -294,9 +309,7 @@ export function SelectInput<T = string, M extends boolean = false>({
       multiple={multiple}
       defaultValue={defaultValue}
       value={controlledValue}
-      // TODO: Remove assertion when upgrading TypeScript to v5
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      by={compareValues as any}
+      by={compareValues}
       disabled={disabled}
       onChange={
         ((value) => {
@@ -349,8 +362,8 @@ export function SelectInput<T = string, M extends boolean = false>({
                   content: !placeholderShown ? (
                     <SelectInputOptionContentWithinTriggerContext.Provider value>
                       {multiple && Array.isArray(value)
-                        ? value
-                            .map((option: NonNullable<T>) => renderValue(option, true))
+                        ? (value as readonly NonNullable<T>[])
+                            .map((option) => renderValue(option, true))
                             .filter((node) => node != null)
                             .join(', ')
                         : renderValue(value as NonNullable<T>, true)}
@@ -379,9 +392,7 @@ export function SelectInput<T = string, M extends boolean = false>({
               setOpen(false);
             }}
             onCloseEnd={() => {
-              if (filterQuery !== '') {
-                setFilterQuery('');
-              }
+              setFilterQuery('');
             }}
           >
             <SelectInputOptions
@@ -392,7 +403,7 @@ export function SelectInput<T = string, M extends boolean = false>({
               filterPlaceholder={filterPlaceholder}
               searchInputRef={searchInputRef}
               listboxRef={listboxRef}
-              filterQuery={filterQuery}
+              filterQuery={deferredFilterQuery}
               onFilterChange={setFilterQuery}
             />
           </OptionsOverlay>
@@ -506,7 +517,48 @@ function SelectInputOptions<T = string>({
     }
     return undefined;
   }, [filterQuery, filterable]);
-  const resultsEmpty = needle != null && filterSelectInputItems(items, needle).length === 0;
+  useEffect(() => {
+    if (needle) {
+      // Ensure having an active option while filtering
+      requestAnimationFrame(() => {
+        if (
+          controllerRef.current != null &&
+          !controllerRef.current.hasAttribute('aria-activedescendant')
+        ) {
+          // Activate first option via synthetic key press
+          controllerRef.current.dispatchEvent(
+            new KeyboardEvent('keydown', { key: 'Home', bubbles: true }),
+          );
+        }
+      });
+    }
+  }, [controllerRef, needle]);
+
+  const filteredItems: readonly SelectInputItem<NonNullable<T> | undefined>[] =
+    needle != null
+      ? filterSelectInputItems(dedupeSelectInputItems(items), (item) =>
+          selectInputOptionItemIncludesNeedle(item, needle),
+        )
+      : items;
+  const resultsEmpty = needle != null && filteredItems.length === 0;
+
+  const virtualized = filteredItems.length > MAX_ITEMS_WITHOUT_VIRTUALIZATION;
+
+  // Items shown once shall be kept mounted until the needle changes, otherwise
+  // the scroll position may jump around inadvertently. Pattern adopted from:
+  // https://inokawa.github.io/virtua/?path=/story/advanced-keep-offscreen-items--append-only
+  const [mountedIndexes, setMountedIndexes] = useState<number[]>([]);
+  useEffect(() => {
+    // Ensure the 'End' key works as intended by keeping the last item mounted
+    setMountedIndexes((prevMountedIndexes) => {
+      const indexes = new Set(prevMountedIndexes);
+      indexes.add(filteredItems.length - 1);
+      return [...indexes]; // Sorting is redundant by nature here
+    });
+  }, [
+    needle, // Needed as `filteredItems.length` may be equal between two updates
+    filteredItems.length,
+  ]);
 
   const listboxContainerRef = useRef<HTMLDivElement>(null);
   useEffect(() => {
@@ -522,6 +574,19 @@ function SelectInputOptions<T = string>({
   const statusId = useId();
   const listboxId = useId();
 
+  const getItemNode = (index: number) => {
+    const item = filteredItems[index];
+    return (
+      <SelectInputItemView
+        // eslint-disable-next-line react/no-array-index-key
+        key={index}
+        item={item}
+        renderValue={renderValue}
+        needle={needle}
+      />
+    );
+  };
+
   return (
     <ListboxBase.Options
       as={SelectInputOptionsContainer}
@@ -533,12 +598,6 @@ function SelectInputOptions<T = string>({
             controllerRef.current.setAttribute('aria-activedescendant', value);
           } else {
             controllerRef.current.removeAttribute('aria-activedescendant');
-            if (filterQuery) {
-              // Ensure having an active option while filtering
-              controllerRef.current.dispatchEvent(
-                new KeyboardEvent('keydown', { key: 'Home', bubbles: true }),
-              );
-            }
           }
         }
       }}
@@ -549,7 +608,7 @@ function SelectInputOptions<T = string>({
             ref={searchInputRef}
             shape="rectangle"
             placeholder={filterPlaceholder}
-            value={filterQuery}
+            defaultValue={filterQuery}
             aria-controls={listboxId}
             aria-describedby={showStatus ? statusId : undefined}
             onKeyDown={(event) => {
@@ -560,6 +619,9 @@ function SelectInputOptions<T = string>({
               }
             }}
             onChange={(event) => {
+              // Free up resources and ensure not to go out of bounds when the
+              // resulting item count is less than before
+              setMountedIndexes([]);
               onFilterChange(event.currentTarget.value);
             }}
           />
@@ -571,7 +633,9 @@ function SelectInputOptions<T = string>({
         tabIndex={-1}
         className={classNames(
           'np-select-input-listbox-container',
-          items.some((item) => item.type === 'group') &&
+          virtualized && 'np-select-input-listbox-container--virtualized',
+          needle == null && // Groups aren't shown when filtering
+            items.some((item) => item.type === 'group') &&
             'np-select-input-listbox-container--has-group',
         )}
       >
@@ -590,15 +654,27 @@ function SelectInputOptions<T = string>({
           tabIndex={0}
           className="np-select-input-listbox"
         >
-          {(needle != null ? dedupeSelectInputItems(items) : items).map((item, index) => (
-            <SelectInputItemView
-              // eslint-disable-next-line react/no-array-index-key
-              key={index}
-              item={item}
-              renderValue={renderValue}
-              needle={needle}
-            />
-          ))}
+          {!virtualized ? (
+            filteredItems.map((_, index) => getItemNode(index))
+          ) : (
+            <Virtualizer
+              key={needle}
+              count={filteredItems.length}
+              keepMounted={mountedIndexes}
+              scrollRef={listboxRef} // `VList` doesn't expose this
+              onRangeChange={(startIndex, endIndex) => {
+                setMountedIndexes((prevMountedIndexes) => {
+                  const indexes = new Set(prevMountedIndexes);
+                  for (let index = startIndex; index <= endIndex; index += 1) {
+                    indexes.add(index);
+                  }
+                  return [...indexes].sort((a, b) => a - b);
+                });
+              }}
+            >
+              {(index) => getItemNode(index)}
+            </Virtualizer>
+          )}
         </div>
 
         {renderFooter != null ? (
@@ -639,7 +715,10 @@ function SelectInputItemView<T = string>({
 }: SelectInputItemViewProps<T>) {
   switch (item.type) {
     case 'option': {
-      if (item.value != null && (needle == null || filterSelectInputOptionItem(item, needle))) {
+      if (
+        item.value != null &&
+        (needle == null || selectInputOptionItemIncludesNeedle(item, needle))
+      ) {
         return (
           <SelectInputOption value={item.value} disabled={item.disabled}>
             {renderValue(item.value, false)}

package/src/main.css

@@ -2655,6 +2655,10 @@ html:not([dir="rtl"]) .np-flow-navigation--sm .np-flow-navigation__stepper {
     height: auto;
   }
 }
+.np-select-input-listbox-container--virtualized {
+  /* The wrapping element shrinks this as needed */
+  height: 100vh;
+}
 .np-select-input-listbox-container--has-group {
   scroll-padding-top: 32px;
   scroll-padding-top: var(--size-32);
@@ -2673,6 +2677,12 @@ html:not([dir="rtl"]) .np-flow-navigation--sm .np-flow-navigation__stepper {
   outline: var(--ring-outline-color) solid var(--ring-outline-width);
   outline-offset: var(--ring-outline-offset);
 }
+.np-select-input-listbox-container--virtualized .np-select-input-listbox {
+  /* Adopted from `VList` in virtua: https://github.com/inokawa/virtua/blob/7f6ed5b37df6b480d4ff350f3960067c5b3519d2/src/react/VList.tsx#L113-L116 */
+  overflow-y: auto;
+  contain: strict;
+  height: 100%;
+}
 .np-select-input-separator-item {
   margin: 8px;
   margin: var(--size-8);

package/src/uploadInput/UploadInput.spec.tsx

@@ -8,6 +8,7 @@ import { mockMatchMedia, render, screen, waitFor, waitForElementToBeRemoved } fr
 
 import UploadInput, { UploadInputProps } from './UploadInput';
 import { TEST_IDS as UPLOAD_BUTTON_TEST_IDS } from './uploadButton/UploadButton';
+import { TEST_IDS as UPLOAD_ITEM_TEST_IDS } from './uploadItem/UploadItem';
 
 const user = userEvent.setup({ advanceTimers: jest.advanceTimersByTimeAsync });
 
@@ -138,8 +139,7 @@ describe('UploadInput', () => {
         onFilesChange,
       });
 
-      const fileToDeleteTestId = `upload-item-${files[0].id}`;
-      const fileToDelete = screen.getByTestId(fileToDeleteTestId);
+      const fileToDelete = screen.getAllByTestId(UPLOAD_ITEM_TEST_IDS.uploadItem)[0];
       within(fileToDelete).getByLabelText('Remove file', { exact: false }).click();
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
@@ -190,8 +190,7 @@ describe('UploadInput', () => {
         onFilesChange,
       });
 
-      const fileToDeleteTestId = `upload-item-${files[0].id}`;
-      const fileToDelete = screen.getByTestId(fileToDeleteTestId);
+      const fileToDelete = screen.getAllByTestId(UPLOAD_ITEM_TEST_IDS.uploadItem)[0];
       within(fileToDelete).getByLabelText('Remove file', { exact: false }).click();
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();

package/src/uploadInput/UploadInput.story.tsx

@@ -51,7 +51,7 @@ export const WithinField: Story = Template.bind({});
 WithinField.decorators = [
   (Story) => (
     <Field message="Something went wrong" sentiment="negative">
-        <Story />
-      </Field>
+      <Story />
+    </Field>
   ),
 ];

package/src/uploadInput/UploadInput.tsx

@@ -128,9 +128,6 @@ const UploadInput = ({
   sizeLimitErrorMessage,
   uploadButtonTitle,
 }: UploadInputProps) => {
-  const uploadButtonRef = useRef<HTMLInputElement | null>(null);
-  const uploadItemRefs = useRef<(HTMLButtonElement | HTMLAnchorElement | null)[]>([]);
-
   const inputAttributes = useInputAttributes({ nonLabelable: true });
 
   const [markedFileForDelete, setMarkedFileForDelete] = useState<UploadedFile | null>(null);
@@ -183,37 +180,19 @@ const UploadInput = ({
     if (status === Status.FAILED) {
       // If removing a failed upload, we're just updating the view
       removeFileFromList(file);
-      // Move focus management logic here for failed status
-      manageFocusAfterRemoval(file);
     } else if (onDeleteFile && id) {
       // Set status to PROCESSING
       modifyFileInList(file, { status: Status.PROCESSING, error: undefined });
 
       // Notify host app about deletion
       onDeleteFile(id)
-        .then(() => {
-          removeFileFromList(file);
-          // Move focus management logic here for successful deletion
-          manageFocusAfterRemoval(file);
-        })
+        .then(() => removeFileFromList(file))
         .catch((error) => {
           modifyFileInList(file, { error: error as UploadError });
         });
     }
   };
 
-  // Extracted focus management logic into a separate function
-  const manageFocusAfterRemoval = (file: UploadedFile) => {
-    const index = uploadedFiles.findIndex((f) => f.id === file.id);
-    const nextFocusIndex = index >= uploadedFiles.length - 1 ? index - 1 : index + 1;
-
-    if (nextFocusIndex >= 0 && uploadItemRefs.current[nextFocusIndex]) {
-      uploadItemRefs.current[nextFocusIndex].focus();
-    } else if (uploadButtonRef.current) {
-      uploadButtonRef.current.focus();
-    }
-  };
-
   function handleFileUploadFailure(file: File, failureMessage: string) {
     const { name } = file;
     const id = generateFileId(file);
@@ -328,13 +307,9 @@ const UploadInput = ({
         className={classNames('np-upload-input', className, { disabled })}
         {...inputAttributes}
       >
-        {uploadedFiles.map((file, index) => (
+        {uploadedFiles.map((file) => (
           <UploadItem
-            ref={(el) => {
-              uploadItemRefs.current[index] = el;
-            }}
             key={file.id}
-            testid={String(file.id)}
             file={file}
             singleFileUpload={!multiple}
             canDelete={
@@ -351,7 +326,6 @@ const UploadInput = ({
         ))}
         {(multiple || (!multiple && !uploadedFiles.length)) && (
           <UploadButton
-            ref={uploadButtonRef}
             id={id}
             uploadButtonTitle={uploadButtonTitle}
             disabled={areMaximumFilesUploadedAlready() || disabled}