@patternfly/react-templates 6.0.0-alpha.2 → 6.0.0-alpha.20

package/src/components/Select/SelectTypeahead.tsx

@@ -0,0 +1,321 @@
+import React from 'react';
+import {
+  Select,
+  SelectOption,
+  SelectList,
+  SelectOptionProps,
+  MenuToggle,
+  MenuToggleElement,
+  TextInputGroup,
+  TextInputGroupMain,
+  TextInputGroupUtilities,
+  Button
+} from '@patternfly/react-core';
+import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon';
+
+export interface SelectTypeaheadOption extends Omit<SelectOptionProps, 'content'> {
+  /** Content of the select option. */
+  content: string | number;
+  /** Value of the select option. */
+  value: string | number;
+}
+
+export interface SelectTypeaheadProps {
+  /** @hide Forwarded ref */
+  innerRef?: React.Ref<any>;
+  /** Initial options of the select. */
+  initialOptions: SelectTypeaheadOption[];
+  /** Callback triggered on selection. */
+  onSelect?: (
+    _event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement>,
+    selection: string | number
+  ) => void;
+  /** Callback triggered when the select opens or closes. */
+  onToggle?: (nextIsOpen: boolean) => void;
+  /** Callback triggered when the text in the input field changes. */
+  onInputChange?: (newValue: string) => void;
+  /** Placeholder text for the select input. */
+  placeholder?: string;
+  /** Message to display when no options match the filter. */
+  noOptionsFoundMessage?: string | ((filter: string) => string);
+  /** Flag indicating the select should be disabled. */
+  isDisabled?: boolean;
+}
+
+export const SelectTypeaheadBase: React.FunctionComponent<SelectTypeaheadProps> = ({
+  innerRef,
+  initialOptions,
+  onSelect,
+  onToggle,
+  onInputChange,
+  placeholder = 'Select an option',
+  noOptionsFoundMessage = (filter) => `No results found for "${filter}"`,
+  isDisabled,
+  ...props
+}: SelectTypeaheadProps) => {
+  const [isOpen, setIsOpen] = React.useState(false);
+  const [selected, setSelected] = React.useState<string>('');
+  const [inputValue, setInputValue] = React.useState<string>('');
+  const [filterValue, setFilterValue] = React.useState<string>('');
+  const [selectOptions, setSelectOptions] = React.useState<SelectTypeaheadOption[]>(initialOptions);
+  const [focusedItemIndex, setFocusedItemIndex] = React.useState<number | null>(null);
+  const [activeItemId, setActiveItemId] = React.useState<string | null>(null);
+  const textInputRef = React.useRef<HTMLInputElement>();
+
+  const NO_RESULTS = 'no results';
+
+  React.useEffect(() => {
+    let newSelectOptions: SelectTypeaheadOption[] = initialOptions;
+
+    // Filter menu items based on the text input value when one exists
+    if (filterValue) {
+      newSelectOptions = initialOptions.filter((option) =>
+        String(option.content).toLowerCase().includes(filterValue.toLowerCase())
+      );
+
+      // When no options are found after filtering, display 'No results found'
+      if (!newSelectOptions.length) {
+        newSelectOptions = [
+          {
+            isAriaDisabled: true,
+            content:
+              typeof noOptionsFoundMessage === 'string' ? noOptionsFoundMessage : noOptionsFoundMessage(filterValue),
+            value: NO_RESULTS
+          }
+        ];
+      }
+
+      // Open the menu when the input value changes and the new value is not empty
+      if (!isOpen) {
+        openMenu();
+      }
+    }
+
+    setSelectOptions(newSelectOptions);
+  }, [filterValue]);
+
+  const createItemId = (value: string | number) => `select-typeahead-${String(value).replace(' ', '-')}`;
+
+  const setActiveAndFocusedItem = (itemIndex: number) => {
+    setFocusedItemIndex(itemIndex);
+    const focusedItem = selectOptions[itemIndex];
+    setActiveItemId(createItemId(focusedItem.value));
+  };
+
+  const resetActiveAndFocusedItem = () => {
+    setFocusedItemIndex(null);
+    setActiveItemId(null);
+  };
+
+  const openMenu = () => {
+    onToggle && onToggle(true);
+    setIsOpen(true);
+  };
+
+  const closeMenu = () => {
+    onToggle && onToggle(false);
+    setIsOpen(false);
+    resetActiveAndFocusedItem();
+  };
+
+  const onInputClick = () => {
+    if (!isOpen) {
+      openMenu();
+    } else if (!inputValue) {
+      closeMenu();
+    }
+  };
+
+  const selectOption = (
+    _event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement> | undefined,
+    option: SelectTypeaheadOption
+  ) => {
+    onSelect && onSelect(_event, option.value);
+
+    setInputValue(String(option.content));
+    setFilterValue('');
+    setSelected(String(option.value));
+
+    closeMenu();
+  };
+
+  const _onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, value: string | number | undefined) => {
+    if (value && value !== NO_RESULTS) {
+      const optionToSelect = selectOptions.find((option) => option.value === value);
+      selectOption(_event, optionToSelect);
+    }
+  };
+
+  const onTextInputChange = (_event: React.FormEvent<HTMLInputElement>, value: string) => {
+    setInputValue(value);
+    onInputChange && onInputChange(value);
+    setFilterValue(value);
+
+    resetActiveAndFocusedItem();
+
+    if (value !== selected) {
+      setSelected('');
+    }
+  };
+
+  const handleMenuArrowKeys = (key: string) => {
+    let indexToFocus = 0;
+
+    if (!isOpen) {
+      openMenu();
+    }
+
+    if (selectOptions.every((option) => option.isDisabled)) {
+      return;
+    }
+
+    if (key === 'ArrowUp') {
+      // When no index is set or at the first index, focus to the last, otherwise decrement focus index
+      if (focusedItemIndex === null || focusedItemIndex === 0) {
+        indexToFocus = selectOptions.length - 1;
+      } else {
+        indexToFocus = focusedItemIndex - 1;
+      }
+
+      // Skip disabled options
+      while (selectOptions[indexToFocus].isDisabled) {
+        indexToFocus--;
+        if (indexToFocus === -1) {
+          indexToFocus = selectOptions.length - 1;
+        }
+      }
+    }
+
+    if (key === 'ArrowDown') {
+      // When no index is set or at the last index, focus to the first, otherwise increment focus index
+      if (focusedItemIndex === null || focusedItemIndex === selectOptions.length - 1) {
+        indexToFocus = 0;
+      } else {
+        indexToFocus = focusedItemIndex + 1;
+      }
+
+      // Skip disabled options
+      while (selectOptions[indexToFocus].isDisabled) {
+        indexToFocus++;
+        if (indexToFocus === selectOptions.length) {
+          indexToFocus = 0;
+        }
+      }
+    }
+
+    setActiveAndFocusedItem(indexToFocus);
+  };
+
+  const onInputKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => {
+    const focusedItem = focusedItemIndex !== null ? selectOptions[focusedItemIndex] : null;
+
+    switch (event.key) {
+      case 'Enter':
+        if (isOpen && focusedItem && focusedItem.value !== NO_RESULTS && !focusedItem.isAriaDisabled) {
+          selectOption(event, focusedItem);
+        }
+
+        if (!isOpen) {
+          setIsOpen(true);
+        }
+
+        break;
+      case 'ArrowUp':
+      case 'ArrowDown':
+        event.preventDefault();
+        handleMenuArrowKeys(event.key);
+        break;
+    }
+  };
+
+  const onToggleClick = () => {
+    onToggle && onToggle(!isOpen);
+    setIsOpen(!isOpen);
+    textInputRef?.current?.focus();
+  };
+
+  const onClearButtonClick = () => {
+    setSelected('');
+    setInputValue('');
+    onInputChange && onInputChange('');
+    setFilterValue('');
+    resetActiveAndFocusedItem();
+    textInputRef?.current?.focus();
+  };
+
+  const toggle = (toggleRef: React.Ref<MenuToggleElement>) => (
+    <MenuToggle
+      ref={toggleRef}
+      variant="typeahead"
+      aria-label="Typeahead menu toggle"
+      onClick={onToggleClick}
+      isExpanded={isOpen}
+      isDisabled={isDisabled}
+      isFullWidth
+    >
+      <TextInputGroup isPlain>
+        <TextInputGroupMain
+          value={inputValue}
+          onClick={onInputClick}
+          onChange={onTextInputChange}
+          onKeyDown={onInputKeyDown}
+          id="typeahead-select-input"
+          autoComplete="off"
+          innerRef={textInputRef}
+          placeholder={placeholder}
+          {...(activeItemId && { 'aria-activedescendant': activeItemId })}
+          role="combobox"
+          isExpanded={isOpen}
+          aria-controls="select-typeahead-listbox"
+        />
+
+        <TextInputGroupUtilities {...(!inputValue ? { style: { display: 'none' } } : {})}>
+          <Button variant="plain" onClick={onClearButtonClick} aria-label="Clear input value">
+            <TimesIcon aria-hidden />
+          </Button>
+        </TextInputGroupUtilities>
+      </TextInputGroup>
+    </MenuToggle>
+  );
+
+  return (
+    <Select
+      id="typeahead-select"
+      isOpen={isOpen}
+      selected={selected}
+      onSelect={_onSelect}
+      onOpenChange={(isOpen) => {
+        !isOpen && closeMenu();
+      }}
+      toggle={toggle}
+      shouldFocusFirstItemOnOpen={false}
+      ref={innerRef}
+      {...props}
+    >
+      <SelectList id="select-typeahead-listbox">
+        {selectOptions.map((option, index) => {
+          const { content, value, ...props } = option;
+
+          return (
+            <SelectOption
+              {...props}
+              key={value}
+              value={value}
+              isFocused={focusedItemIndex === index}
+              id={createItemId(value)}
+            >
+              {content}
+            </SelectOption>
+          );
+        })}
+      </SelectList>
+    </Select>
+  );
+};
+SelectTypeaheadBase.displayName = 'SelectTypeaheadBase';
+
+export const SelectTypeahead = React.forwardRef((props: SelectTypeaheadProps, ref: React.Ref<any>) => (
+  <SelectTypeaheadBase {...props} innerRef={ref} />
+));
+
+SelectTypeahead.displayName = 'SelectTypeahead';

package/src/components/Select/__snapshots__/CheckboxSelectSnapshots.test.tsx.snap

@@ -76,7 +76,7 @@ exports[`opened checkbox select snapshot 1`] = `
   <div
     class="pf-v6-c-menu"
     data-ouia-component-id="OUIA-Generated-Select-3"
-    data-ouia-component-type="PF5/Select"
+    data-ouia-component-type="PF6/Select"
     data-ouia-safe="true"
     data-popper-escaped="true"
     data-popper-placement="bottom-start"
@@ -114,7 +114,7 @@ exports[`opened checkbox select snapshot 1`] = `
                     aria-invalid="false"
                     class="pf-v6-c-check__input"
                     data-ouia-component-id="OUIA-Generated-Checkbox-1"
-                    data-ouia-component-type="PF5/Checkbox"
+                    data-ouia-component-type="PF6/Checkbox"
                     data-ouia-safe="true"
                     id="generated-id"
                     type="checkbox"
@@ -152,7 +152,7 @@ exports[`opened checkbox select snapshot 1`] = `
                     aria-invalid="false"
                     class="pf-v6-c-check__input"
                     data-ouia-component-id="OUIA-Generated-Checkbox-2"
-                    data-ouia-component-type="PF5/Checkbox"
+                    data-ouia-component-type="PF6/Checkbox"
                     data-ouia-safe="true"
                     id="generated-id"
                     type="checkbox"
@@ -190,7 +190,7 @@ exports[`opened checkbox select snapshot 1`] = `
                     aria-invalid="false"
                     class="pf-v6-c-check__input"
                     data-ouia-component-id="OUIA-Generated-Checkbox-3"
-                    data-ouia-component-type="PF5/Checkbox"
+                    data-ouia-component-type="PF6/Checkbox"
                     data-ouia-safe="true"
                     id="generated-id"
                     type="checkbox"

package/src/components/Select/examples/SelectTemplates.md

@@ -4,7 +4,7 @@ section: components
 subsection: menus
 template: true
 beta: true
-propComponents: ['SelectSimple', 'CheckboxSelect']
+propComponents: ['SelectSimple', 'CheckboxSelect', 'SelectTypeahead']
 ---
 
 Note: Templates live in their own package at [@patternfly/react-templates](https://www.npmjs.com/package/@patternfly/react-templates)!
@@ -12,7 +12,7 @@ Note: Templates live in their own package at [@patternfly/react-templates](https
 For custom use cases, please see the select component suite from [@patternfly/react-core](https://www.npmjs.com/package/@patternfly/react-core).
 
 import { SelectOption, Checkbox } from '@patternfly/react-core';
-import { SelectSimple, CheckboxSelect } from '@patternfly/react-templates';
+import { SelectSimple, CheckboxSelect, SelectTypeahead } from '@patternfly/react-templates';
 
 ## Select template examples
 
@@ -25,4 +25,11 @@ import { SelectSimple, CheckboxSelect } from '@patternfly/react-templates';
 ### Checkbox
 
 ```ts file="CheckboxSelectDemo.tsx"
+
+```
+
+### Typeahead
+
+```ts file="SelectTypeaheadDemo.tsx"
+
 ```

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

@@ -0,0 +1,21 @@
+import React from 'react';
+import { SelectTypeahead, SelectTypeaheadOption } from '@patternfly/react-templates';
+
+export const SelectTypeaheadDemo: React.FunctionComponent = () => {
+  const initialOptions: SelectTypeaheadOption[] = [
+    { content: 'Alabama', value: 'option1' },
+    { content: 'Florida', value: 'option2' },
+    { content: 'New Jersey', value: 'option3' },
+    { content: 'New Mexico', value: 'option4' },
+    { content: 'New York', value: 'option5' },
+    { content: 'North Carolina', value: 'option6' }
+  ];
+
+  return (
+    <SelectTypeahead
+      initialOptions={initialOptions}
+      placeholder="Select a state"
+      noOptionsFoundMessage={(filter) => `No state was found for "${filter}"`}
+    />
+  );
+};

package/src/components/Select/index.ts

@@ -1,2 +1,3 @@
 export * from './SelectSimple';
 export * from './CheckboxSelect';
+export * from './SelectTypeahead';

package/src/components/index.ts

@@ -1 +1,2 @@
+export * from './Dropdown';
 export * from './Select';