-
Notifications
You must be signed in to change notification settings - Fork 357
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(MultiTypeaheadSelect): Add MultiTypeaheadSelect to react-templates
- Loading branch information
1 parent
f81bc58
commit ccf4280
Showing
6 changed files
with
985 additions
and
1 deletion.
There are no files selected for viewing
348 changes: 348 additions & 0 deletions
348
packages/react-templates/src/components/Select/MultiTypeaheadSelect.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,348 @@ | ||
import React from 'react'; | ||
import { | ||
Select, | ||
SelectOption, | ||
SelectList, | ||
SelectOptionProps, | ||
MenuToggle, | ||
MenuToggleElement, | ||
TextInputGroup, | ||
TextInputGroupMain, | ||
TextInputGroupUtilities, | ||
Button, | ||
MenuToggleProps, | ||
SelectProps, | ||
ChipGroup, | ||
Chip | ||
} from '@patternfly/react-core'; | ||
import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon'; | ||
|
||
export interface MultiTypeaheadSelectOption extends Omit<SelectOptionProps, 'content'> { | ||
/** Content of the select option. */ | ||
content: string | number; | ||
/** Value of the select option. */ | ||
value: string | number; | ||
} | ||
|
||
export interface MultiTypeaheadSelectProps extends Omit<SelectProps, 'toggle' | 'onSelect'> { | ||
/** @hide Forwarded ref */ | ||
innerRef?: React.Ref<any>; | ||
/** Initial options of the select. */ | ||
initialOptions: MultiTypeaheadSelectOption[]; | ||
/** Callback triggered on selection. */ | ||
onSelectionChange?: ( | ||
_event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement>, | ||
selections: (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; | ||
/** Width of the toggle. */ | ||
toggleWidth?: string; | ||
/** Additional props passed to the toggle. */ | ||
toggleProps?: MenuToggleProps; | ||
} | ||
|
||
export const MultiTypeaheadSelectBase: React.FunctionComponent<MultiTypeaheadSelectProps> = ({ | ||
innerRef, | ||
initialOptions, | ||
onSelectionChange, | ||
onToggle, | ||
onInputChange, | ||
placeholder = 'Select an option', | ||
noOptionsFoundMessage = (filter) => `No results found for "${filter}"`, | ||
isDisabled, | ||
toggleWidth, | ||
toggleProps, | ||
...props | ||
}: MultiTypeaheadSelectProps) => { | ||
const [isOpen, setIsOpen] = React.useState(false); | ||
const [selected, setSelected] = React.useState<(string | number)[]>( | ||
(initialOptions?.filter((o) => o.selected) ?? []).map((o) => o.value) | ||
); | ||
const [inputValue, setInputValue] = React.useState<string>(); | ||
const [selectOptions, setSelectOptions] = React.useState<MultiTypeaheadSelectOption[]>(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'; | ||
|
||
const openMenu = () => { | ||
onToggle && onToggle(true); | ||
setIsOpen(true); | ||
}; | ||
|
||
React.useEffect(() => { | ||
let newSelectOptions: MultiTypeaheadSelectOption[] = initialOptions; | ||
|
||
// Filter menu items based on the text input value when one exists | ||
if (inputValue) { | ||
newSelectOptions = initialOptions.filter((option) => | ||
String(option.content).toLowerCase().includes(inputValue.toLowerCase()) | ||
); | ||
|
||
// When no options are found after filtering, display 'No results found' | ||
if (!newSelectOptions.length) { | ||
newSelectOptions = [ | ||
{ | ||
isAriaDisabled: true, | ||
content: | ||
typeof noOptionsFoundMessage === 'string' ? noOptionsFoundMessage : noOptionsFoundMessage(inputValue), | ||
value: NO_RESULTS | ||
} | ||
]; | ||
} | ||
|
||
// Open the menu when the input value changes and the new value is not empty | ||
openMenu(); | ||
} | ||
|
||
setSelectOptions(newSelectOptions); | ||
// eslint-disable-next-line react-hooks/exhaustive-deps | ||
}, [inputValue, initialOptions]); | ||
|
||
React.useEffect( | ||
() => setSelected((initialOptions?.filter((o) => o.selected) ?? []).map((o) => o.value)), | ||
[initialOptions] | ||
); | ||
|
||
const setActiveAndFocusedItem = (itemIndex: number) => { | ||
setFocusedItemIndex(itemIndex); | ||
const focusedItem = selectOptions[itemIndex]; | ||
setActiveItemId(focusedItem.value as string); | ||
}; | ||
|
||
const resetActiveAndFocusedItem = () => { | ||
setFocusedItemIndex(null); | ||
setActiveItemId(null); | ||
}; | ||
|
||
const closeMenu = () => { | ||
onToggle && onToggle(false); | ||
setIsOpen(false); | ||
resetActiveAndFocusedItem(); | ||
setInputValue(''); | ||
}; | ||
|
||
const onInputClick = () => { | ||
if (!isOpen) { | ||
openMenu(); | ||
} else if (!inputValue) { | ||
closeMenu(); | ||
} | ||
}; | ||
|
||
const selectOption = ( | ||
_event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement> | undefined, | ||
option: string | number | ||
) => { | ||
const selections = selected.includes(option) ? selected.filter((o) => option === o) : [...selected, option]; | ||
|
||
onSelectionChange && onSelectionChange(_event, selections); | ||
setSelected(selections); | ||
}; | ||
|
||
const clearOption = ( | ||
_event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<HTMLInputElement> | undefined, | ||
option: string | number | ||
) => { | ||
const selections = selected.filter((o) => option !== o); | ||
onSelectionChange && onSelectionChange(_event, selections); | ||
setSelected(selections); | ||
}; | ||
|
||
const _onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, value: string | number | undefined) => { | ||
if (value && value !== NO_RESULTS) { | ||
selectOption(_event, value); | ||
} | ||
}; | ||
|
||
const onTextInputChange = (_event: React.FormEvent<HTMLInputElement>, value: string) => { | ||
setInputValue(value); | ||
onInputChange && onInputChange(value); | ||
|
||
resetActiveAndFocusedItem(); | ||
}; | ||
|
||
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?.value); | ||
} | ||
|
||
if (!isOpen) { | ||
onToggle && onToggle(true); | ||
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 = (ev: React.MouseEvent) => { | ||
setSelected([]); | ||
onInputChange && onInputChange(''); | ||
resetActiveAndFocusedItem(); | ||
textInputRef?.current?.focus(); | ||
onSelectionChange && onSelectionChange(ev, []); | ||
}; | ||
|
||
const toggle = (toggleRef: React.Ref<MenuToggleElement>) => ( | ||
<MenuToggle | ||
ref={toggleRef} | ||
variant="typeahead" | ||
aria-label="Multi select Typeahead menu toggle" | ||
onClick={onToggleClick} | ||
isExpanded={isOpen} | ||
isDisabled={isDisabled} | ||
isFullWidth | ||
style={ | ||
{ | ||
width: toggleWidth | ||
} as React.CSSProperties | ||
} | ||
{...toggleProps} | ||
> | ||
<TextInputGroup isPlain> | ||
<TextInputGroupMain | ||
value={inputValue} | ||
onClick={onInputClick} | ||
onChange={onTextInputChange} | ||
onKeyDown={onInputKeyDown} | ||
autoComplete="off" | ||
innerRef={textInputRef} | ||
placeholder={placeholder} | ||
{...(activeItemId && { 'aria-activedescendant': activeItemId })} | ||
role="combobox" | ||
isExpanded={isOpen} | ||
aria-controls="select-typeahead-listbox" | ||
> | ||
<ChipGroup aria-label="Current selections"> | ||
{selected.map((selection, index) => ( | ||
<Chip | ||
key={index} | ||
datatest-id={`${selection}-chip`} | ||
onClick={(ev) => { | ||
ev.stopPropagation(); | ||
clearOption(ev, selection); | ||
}} | ||
> | ||
{initialOptions.find((o) => o.value === selection)?.content} | ||
</Chip> | ||
))} | ||
</ChipGroup> | ||
</TextInputGroupMain> | ||
<TextInputGroupUtilities {...(selected.length === 0 ? { style: { display: 'none' } } : {})}> | ||
<Button variant="plain" onClick={onClearButtonClick} aria-label="Clear input value"> | ||
<TimesIcon aria-hidden /> | ||
</Button> | ||
</TextInputGroupUtilities> | ||
</TextInputGroup> | ||
</MenuToggle> | ||
); | ||
|
||
return ( | ||
<Select | ||
isOpen={isOpen} | ||
selected={selected} | ||
onSelect={_onSelect} | ||
onOpenChange={(isOpen) => { | ||
!isOpen && closeMenu(); | ||
}} | ||
toggle={toggle} | ||
shouldFocusFirstItemOnOpen={false} | ||
ref={innerRef} | ||
{...props} | ||
> | ||
<SelectList> | ||
{selectOptions.map((option, index) => { | ||
const { content, value, ...props } = option; | ||
|
||
return ( | ||
<SelectOption key={value} value={value} isFocused={focusedItemIndex === index} {...props}> | ||
{content} | ||
</SelectOption> | ||
); | ||
})} | ||
</SelectList> | ||
</Select> | ||
); | ||
}; | ||
|
||
MultiTypeaheadSelectBase.displayName = 'MultiTypeaheadSelectBase'; | ||
|
||
export const MultiTypeaheadSelect = React.forwardRef((props: MultiTypeaheadSelectProps, ref: React.Ref<any>) => ( | ||
<MultiTypeaheadSelectBase {...props} innerRef={ref} /> | ||
)); | ||
|
||
MultiTypeaheadSelect.displayName = 'MultiTypeaheadSelect'; |
Oops, something went wrong.