bigbuffet-rw/packages/pl-fe/src/components/autosuggest-input.tsx

314 lines
9.3 KiB
TypeScript
Raw Normal View History

2023-02-06 10:01:03 -08:00
import clsx from 'clsx';
import React, { PureComponent } from 'react';
import AutosuggestEmoji from 'pl-fe/components/autosuggest-emoji';
import Icon from 'pl-fe/components/icon';
import Input from 'pl-fe/components/ui/input';
import Portal from 'pl-fe/components/ui/portal';
import AutosuggestAccount from 'pl-fe/features/compose/components/autosuggest-account';
import { textAtCursorMatchesToken } from 'pl-fe/utils/suggestions';
import type { Menu, MenuItem } from 'pl-fe/components/dropdown-menu';
import type { InputThemes } from 'pl-fe/components/ui/input';
import type { Emoji } from 'pl-fe/features/emoji';
type AutoSuggestion = string | Emoji;
2022-06-04 16:35:04 -07:00
interface IAutosuggestInput extends Pick<React.HTMLAttributes<HTMLInputElement>, 'onChange' | 'onKeyUp' | 'onKeyDown'> {
value: string;
suggestions: Array<any>;
disabled?: boolean;
placeholder?: string;
onSuggestionSelected: (tokenStart: number, lastToken: string | null, suggestion: AutoSuggestion) => void;
onSuggestionsClearRequested: () => void;
onSuggestionsFetchRequested: (token: string) => void;
autoFocus: boolean;
autoSelect: boolean;
className?: string;
id?: string;
searchTokens: string[];
maxLength?: number;
menu?: Menu;
renderSuggestion?: React.FC<{ id: string }>;
hidePortal?: boolean;
theme?: InputThemes;
2022-06-04 16:21:16 -07:00
}
class AutosuggestInput extends PureComponent<IAutosuggestInput> {
2020-03-27 13:59:38 -07:00
static defaultProps = {
2021-10-14 10:35:05 -07:00
autoFocus: false,
autoSelect: true,
searchTokens: ['@', ':', '#'],
2020-03-27 13:59:38 -07:00
};
getFirstIndex = () => this.props.autoSelect ? 0 : -1;
2020-03-27 13:59:38 -07:00
state = {
suggestionsHidden: true,
focused: false,
selectedSuggestion: this.getFirstIndex(),
2020-03-27 13:59:38 -07:00
lastToken: null,
tokenStart: 0,
};
2022-06-04 16:21:16 -07:00
input: HTMLInputElement | null = null;
onChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {
2022-11-22 06:55:31 -08:00
const [tokenStart, token] = textAtCursorMatchesToken(
e.target.value,
e.target.selectionStart || 0,
this.props.searchTokens,
);
2020-03-27 13:59:38 -07:00
if (token !== null && this.state.lastToken !== token) {
this.setState({ lastToken: token, selectedSuggestion: 0, tokenStart });
this.props.onSuggestionsFetchRequested(token);
} else if (token === null) {
this.setState({ lastToken: null });
this.props.onSuggestionsClearRequested();
}
2022-06-04 16:21:16 -07:00
if (this.props.onChange) {
this.props.onChange(e);
}
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
2022-06-04 16:21:16 -07:00
onKeyDown: React.KeyboardEventHandler<HTMLInputElement> = (e) => {
2021-11-01 11:45:17 -07:00
const { suggestions, menu, disabled } = this.props;
2020-03-27 13:59:38 -07:00
const { selectedSuggestion, suggestionsHidden } = this.state;
const firstIndex = this.getFirstIndex();
const lastIndex = suggestions.length + (menu || []).length - 1;
2020-03-27 13:59:38 -07:00
if (disabled) {
e.preventDefault();
return;
}
2022-06-04 16:21:16 -07:00
if (e.which === 229) {
2020-03-27 13:59:38 -07:00
// Ignore key events during text composition
// e.key may be a name of the physical key even in this case (e.x. Safari / Chrome on Mac)
return;
}
switch (e.key) {
2022-05-11 14:06:35 -07:00
case 'Escape':
if (suggestions.length === 0 || suggestionsHidden) {
2022-06-04 16:21:16 -07:00
document.querySelector('.ui')?.parentElement?.focus();
2021-11-01 11:45:17 -07:00
} else {
2022-05-11 14:06:35 -07:00
e.preventDefault();
this.setState({ suggestionsHidden: true });
}
break;
case 'ArrowDown':
if (!suggestionsHidden && (suggestions.length > 0 || menu)) {
2022-05-11 14:06:35 -07:00
e.preventDefault();
this.setState({ selectedSuggestion: Math.min(selectedSuggestion + 1, lastIndex) });
}
break;
case 'ArrowUp':
if (!suggestionsHidden && (suggestions.length > 0 || menu)) {
2022-05-11 14:06:35 -07:00
e.preventDefault();
this.setState({ selectedSuggestion: Math.max(selectedSuggestion - 1, firstIndex) });
}
break;
case 'Enter':
case 'Tab':
2022-06-04 16:21:16 -07:00
// Select suggestion
if (!suggestionsHidden && selectedSuggestion > -1 && (suggestions.length > 0 || menu)) {
2022-05-11 14:06:35 -07:00
e.preventDefault();
e.stopPropagation();
this.setState({ selectedSuggestion: firstIndex });
if (selectedSuggestion < suggestions.length) {
this.props.onSuggestionSelected(this.state.tokenStart, this.state.lastToken, suggestions[selectedSuggestion]);
2022-06-04 16:21:16 -07:00
} else if (menu) {
const item = menu[selectedSuggestion - suggestions.length];
2022-06-04 16:21:16 -07:00
this.handleMenuItemAction(item, e);
2022-05-11 14:06:35 -07:00
}
2021-11-01 11:45:17 -07:00
}
2020-03-27 13:59:38 -07:00
2022-05-11 14:06:35 -07:00
break;
2020-03-27 13:59:38 -07:00
}
if (e.defaultPrevented || !this.props.onKeyDown) {
return;
}
2022-06-04 16:21:16 -07:00
if (this.props.onKeyDown) {
this.props.onKeyDown(e);
}
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
onBlur = () => {
this.setState({ suggestionsHidden: true, focused: false });
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
onFocus = () => {
this.setState({ focused: true });
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
onSuggestionClick: React.EventHandler<React.MouseEvent | React.TouchEvent> = (e) => {
2022-06-04 16:21:16 -07:00
const index = Number(e.currentTarget?.getAttribute('data-index'));
const suggestion = this.props.suggestions[index];
2020-03-27 13:59:38 -07:00
this.props.onSuggestionSelected(this.state.tokenStart, this.state.lastToken, suggestion);
2022-06-04 16:21:16 -07:00
this.input?.focus();
e.preventDefault();
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
2022-06-04 16:21:16 -07:00
componentDidUpdate(prevProps: IAutosuggestInput, prevState: any) {
const { suggestions } = this.props;
if (suggestions !== prevProps.suggestions && suggestions.length > 0 && prevState.suggestionsHidden && prevState.focused) {
this.setState({ suggestionsHidden: false });
2020-03-27 13:59:38 -07:00
}
}
2022-06-04 16:21:16 -07:00
setInput = (c: HTMLInputElement) => {
2020-03-27 13:59:38 -07:00
this.input = c;
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
2022-06-04 16:36:34 -07:00
renderSuggestion = (suggestion: AutoSuggestion, i: number) => {
2020-03-27 13:59:38 -07:00
const { selectedSuggestion } = this.state;
let inner, key;
if (this.props.renderSuggestion && typeof suggestion === 'string') {
const RenderSuggestion = this.props.renderSuggestion;
inner = <RenderSuggestion id={suggestion} />;
key = suggestion;
} else if (typeof suggestion === 'object') {
2020-03-27 13:59:38 -07:00
inner = <AutosuggestEmoji emoji={suggestion} />;
2022-06-07 08:11:28 -07:00
key = suggestion.id;
2020-03-27 13:59:38 -07:00
} else if (suggestion[0] === '#') {
inner = suggestion;
2022-06-07 08:11:28 -07:00
key = suggestion;
2020-03-27 13:59:38 -07:00
} else {
2022-03-21 11:09:01 -07:00
inner = <AutosuggestAccount id={suggestion} />;
2022-06-07 08:11:28 -07:00
key = suggestion;
2020-03-27 13:59:38 -07:00
}
return (
2022-03-21 11:09:01 -07:00
<div
role='button'
2022-06-04 16:21:16 -07:00
tabIndex={0}
2022-03-21 11:09:01 -07:00
key={key}
data-index={i}
2023-02-06 10:01:03 -08:00
className={clsx({
'px-4 py-2.5 text-sm text-gray-700 dark:text-gray-500 focus:bg-gray-100 dark:focus:bg-primary-800 group': true,
'hover:bg-gray-100 dark:hover:bg-gray-800': i !== selectedSuggestion,
'bg-gray-100 dark:bg-gray-800 hover:bg-gray-100 dark:hover:bg-gray-800': i === selectedSuggestion,
2022-03-21 11:09:01 -07:00
})}
onMouseDown={this.onSuggestionClick}
onTouchEnd={this.onSuggestionClick}
2022-03-21 11:09:01 -07:00
>
2020-03-27 13:59:38 -07:00
{inner}
</div>
);
2023-01-05 09:55:08 -08:00
};
2020-03-27 13:59:38 -07:00
2022-06-04 16:21:16 -07:00
handleMenuItemAction = (item: MenuItem | null, e: React.MouseEvent | React.KeyboardEvent) => {
2021-11-01 11:45:17 -07:00
this.onBlur();
2022-06-04 16:21:16 -07:00
if (item?.action) {
item.action(e);
}
2023-01-05 09:55:08 -08:00
};
2021-11-01 11:45:17 -07:00
handleMenuItemClick = (item: MenuItem | null): React.MouseEventHandler => e => {
e.preventDefault();
this.handleMenuItemAction(item, e);
2023-01-05 09:55:08 -08:00
};
2021-11-01 11:45:17 -07:00
renderMenu = () => {
const { menu, suggestions } = this.props;
const { selectedSuggestion } = this.state;
if (!menu) {
return null;
}
return menu.map((item, i) => (
<a
className={clsx('flex cursor-pointer items-center space-x-2 px-4 py-2.5 text-sm text-gray-700 hover:bg-gray-100 focus:bg-gray-100 dark:text-gray-500 dark:hover:bg-gray-800 dark:focus:bg-primary-800', {
selected: suggestions.length - selectedSuggestion === i,
})}
2021-11-01 11:45:17 -07:00
href='#'
role='button'
2022-06-04 16:21:16 -07:00
tabIndex={0}
2021-11-01 11:45:17 -07:00
onMouseDown={this.handleMenuItemClick(item)}
key={i}
>
2022-06-04 16:21:16 -07:00
{item?.icon && (
2021-11-01 11:53:30 -07:00
<Icon src={item.icon} />
)}
2022-06-04 16:21:16 -07:00
<span>{item?.text}</span>
2021-11-01 11:45:17 -07:00
</a>
));
};
setPortalPosition() {
if (!this.input) {
return {};
}
const { top, height, left, width } = this.input.getBoundingClientRect();
return { left, width, top: top + height };
}
render() {
const { value, suggestions, disabled, placeholder, onKeyUp, autoFocus, className, id, maxLength, menu, theme } = this.props;
2020-03-27 13:59:38 -07:00
const { suggestionsHidden } = this.state;
const visible = !suggestionsHidden && (suggestions.length || (menu && value));
2021-11-01 11:45:17 -07:00
return [
<div key='input' className='relative w-full'>
2022-03-21 11:09:01 -07:00
<label className='sr-only'>{placeholder}</label>
<Input
2022-03-21 11:09:01 -07:00
type='text'
className={className}
2022-10-04 14:25:02 -07:00
outerClassName='mt-0'
2022-03-21 11:09:01 -07:00
ref={this.setInput}
disabled={disabled}
placeholder={placeholder}
autoFocus={autoFocus}
value={value}
onChange={this.onChange}
onKeyDown={this.onKeyDown}
onKeyUp={onKeyUp}
onFocus={this.onFocus}
onBlur={this.onBlur}
aria-autocomplete='list'
id={id}
maxLength={maxLength}
2022-04-06 07:10:21 -07:00
data-testid='autosuggest-input'
theme={theme}
2022-03-21 11:09:01 -07:00
/>
</div>,
<Portal key='portal'>
<div
style={this.setPortalPosition()}
2023-02-06 10:01:03 -08:00
className={clsx({
'fixed w-full z-[1001] shadow bg-white dark:bg-gray-900 rounded-lg py-1 dark:ring-2 dark:ring-primary-700 focus:outline-none': true,
hidden: !visible,
block: visible,
})}
2022-03-21 11:09:01 -07:00
>
<div className='space-y-0.5'>
{suggestions.map(this.renderSuggestion)}
</div>
2021-11-01 11:45:17 -07:00
{this.renderMenu()}
2020-03-27 13:59:38 -07:00
</div>
</Portal>,
];
2020-03-27 13:59:38 -07:00
}
}
export { type AutoSuggestion, type IAutosuggestInput, AutosuggestInput as default };