@patternfly/react-templates 1.1.0-prerelease.36 → 1.1.0-prerelease.38

package/src/components/Select/TypeaheadSelect.tsx

@@ -22,14 +22,14 @@ export interface TypeaheadSelectOption extends Omit<SelectOptionProps, 'content'
   value: string | number;
 }
 
-export interface TypeaheadSelectProps extends Omit<SelectProps, 'toggle'> {
+export interface TypeaheadSelectProps extends Omit<SelectProps, 'toggle' | 'onSelect'> {
   /** @hide Forwarded ref */
   innerRef?: React.Ref<any>;
   /** Initial options of the select. */
   initialOptions: TypeaheadSelectOption[];
   /** Callback triggered on selection. */
   onSelect?: (
-    _event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement>,
+    _event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement> | undefined,
     selection: string | number
   ) => void;
   /** Callback triggered when the select opens or closes. */
@@ -40,6 +40,12 @@ export interface TypeaheadSelectProps extends Omit<SelectProps, 'toggle'> {
   onClearSelection?: () => void;
   /** Placeholder text for the select input. */
   placeholder?: string;
+  /** Flag to indicate if the typeahead select allows new items */
+  isCreatable?: boolean;
+  /** Flag to indicate if create option should be at top of typeahead */
+  isCreateOptionOnTop?: boolean;
+  /** Message to display to create a new option */
+  createOptionMessage?: string | ((newValue: string) => string);
   /** Message to display when no options are available. */
   noOptionsAvailableMessage?: string;
   /** Message to display when no options match the filter. */
@@ -52,6 +58,9 @@ export interface TypeaheadSelectProps extends Omit<SelectProps, 'toggle'> {
   toggleProps?: MenuToggleProps;
 }
 
+const defaultNoOptionsFoundMessage = (filter: string) => `No results found for "${filter}"`;
+const defaultCreateOptionMessage = (newValue: string) => `Create "${newValue}"`;
+
 export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps> = ({
   innerRef,
   initialOptions,
@@ -61,7 +70,10 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
   onClearSelection,
   placeholder = 'Select an option',
   noOptionsAvailableMessage = 'No options are available',
-  noOptionsFoundMessage = (filter) => `No results found for "${filter}"`,
+  noOptionsFoundMessage = defaultNoOptionsFoundMessage,
+  isCreatable = false,
+  isCreateOptionOnTop = false,
+  createOptionMessage = defaultCreateOptionMessage,
   isDisabled,
   toggleWidth,
   toggleProps,
@@ -89,6 +101,20 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
         String(option.content).toLowerCase().includes(filterValue.toLowerCase())
       );
 
+      if (
+        isCreatable &&
+        filterValue &&
+        !initialOptions.find((o) => String(o.content).toLowerCase() === filterValue.toLowerCase())
+      ) {
+        const createOption = {
+          content: typeof createOptionMessage === 'string' ? createOptionMessage : createOptionMessage(filterValue),
+          value: filterValue
+        };
+        newSelectOptions = isCreateOptionOnTop
+          ? [createOption, ...newSelectOptions]
+          : [...newSelectOptions, createOption];
+      }
+
       // When no options are found after filtering, display 'No results found'
       if (!newSelectOptions.length) {
         newSelectOptions = [
@@ -102,9 +128,7 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
       }
 
       // Open the menu when the input value changes and the new value is not empty
-      if (!isOpen) {
-        openMenu();
-      }
+      openMenu();
     }
 
     // When no options are  available,  display 'No options available'
@@ -119,17 +143,30 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
     }
 
     setSelectOptions(newSelectOptions);
-  }, [filterValue, initialOptions]);
+  }, [
+    filterValue,
+    initialOptions,
+    noOptionsFoundMessage,
+    isCreatable,
+    isCreateOptionOnTop,
+    createOptionMessage,
+    noOptionsAvailableMessage
+  ]);
 
   React.useEffect(() => {
+    // If the selected option changed and the current input value is the previously selected item, update the displayed value.
     const selectedOption = initialOptions.find((o) => o.selected);
-    setInputValue(String(selectedOption?.content ?? ''));
+    if (inputValue === selected && selectedOption?.value !== selected) {
+      setInputValue(String(selectedOption?.content ?? ''));
+    }
+    // Only update when options change
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [initialOptions]);
 
   const setActiveAndFocusedItem = (itemIndex: number) => {
     setFocusedItemIndex(itemIndex);
     const focusedItem = selectOptions[itemIndex];
-    setActiveItemId(focusedItem.value as string);
+    setActiveItemId(String(focusedItem.value));
   };
 
   const resetActiveAndFocusedItem = () => {
@@ -138,8 +175,10 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
   };
 
   const openMenu = () => {
-    onToggle && onToggle(true);
-    setIsOpen(true);
+    if (!isOpen) {
+      onToggle && onToggle(true);
+      setIsOpen(true);
+    }
   };
 
   const closeMenu = () => {
@@ -191,9 +230,7 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
   const handleMenuArrowKeys = (key: string) => {
     let indexToFocus = 0;
 
-    if (!isOpen) {
-      openMenu();
-    }
+    openMenu();
 
     if (selectOptions.every((option) => option.isDisabled)) {
       return;
@@ -245,10 +282,7 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
           selectOption(event, focusedItem);
         }
 
-        if (!isOpen) {
-          onToggle && onToggle(true);
-          setIsOpen(true);
-        }
+        openMenu();
 
         break;
       case 'ArrowUp':
@@ -262,7 +296,7 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
   const onToggleClick = () => {
     onToggle && onToggle(!isOpen);
     setIsOpen(!isOpen);
-    textInputRef?.current?.focus();
+    textInputRef.current?.focus();
   };
 
   const onClearButtonClick = () => {
@@ -271,7 +305,7 @@ export const TypeaheadSelectBase: React.FunctionComponent<TypeaheadSelectProps>
     onInputChange && onInputChange('');
     setFilterValue('');
     resetActiveAndFocusedItem();
-    textInputRef?.current?.focus();
+    textInputRef.current?.focus();
     onClearSelection && onClearSelection();
   };
 

package/src/components/Select/examples/TypeaheadSelectDemo.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
 import { TypeaheadSelect, TypeaheadSelectOption } from '@patternfly/react-templates';
+import { Checkbox } from '@patternfly/react-core';
 
 const Options = [
   { content: 'Alabama', value: 'option1' },
@@ -13,10 +14,13 @@ const Options = [
 /* eslint-disable no-console */
 export const SelectTypeaheadDemo: React.FunctionComponent = () => {
   const [selected, setSelected] = React.useState<string | undefined>();
+  const [options, setOptions] = React.useState(Options);
+  const [isCreatable, setIsCreatable] = React.useState<boolean>(false);
+  const [isCreateOptionOnTop, setIsCreateOptionOnTop] = React.useState<boolean>(false);
 
   const initialOptions = React.useMemo<TypeaheadSelectOption[]>(
-    () => Options.map((o) => ({ ...o, selected: o.value === selected })),
-    [selected]
+    () => options.map((o) => ({ ...o, selected: o.value === selected })),
+    [options, selected]
   );
 
   React.useEffect(() => {
@@ -24,12 +28,38 @@ export const SelectTypeaheadDemo: React.FunctionComponent = () => {
   }, [selected]);
 
   return (
-    <TypeaheadSelect
-      initialOptions={initialOptions}
-      placeholder="Select a state"
-      noOptionsFoundMessage={(filter) => `No state was found for "${filter}"`}
-      onClearSelection={() => setSelected(undefined)}
-      onSelect={(_ev, selection) => setSelected(String(selection))}
-    />
+    <>
+      <TypeaheadSelect
+        initialOptions={initialOptions}
+        placeholder="Select a state"
+        noOptionsFoundMessage={(filter) => `No state was found for "${filter}"`}
+        onClearSelection={() => setSelected(undefined)}
+        onSelect={(_ev, selection) => {
+          if (!options.find((o) => o.value === selection)) {
+            setOptions([...options, { content: String(selection), value: String(selection) }]);
+          }
+          setSelected(String(selection));
+        }}
+        isCreatable={isCreatable}
+        isCreateOptionOnTop={isCreateOptionOnTop}
+      />
+      <Checkbox
+        className="pf-u-mt-sm"
+        label="isCreatable"
+        isChecked={isCreatable}
+        onChange={(_event, checked) => setIsCreatable(checked)}
+        aria-label="toggle creatable checkbox"
+        id="toggle-creatable-typeahead"
+        name="toggle-creatable-typeahead"
+      />
+      <Checkbox
+        label="isCreateOptionOnTop"
+        isChecked={isCreateOptionOnTop}
+        onChange={(_event, checked) => setIsCreateOptionOnTop(checked)}
+        aria-label="toggle createOptionOnTop checkbox"
+        id="toggle-create-option-on-top-typeahead"
+        name="toggle-create-option-on-top-typeahead"
+      />
+    </>
   );
 };