-
Notifications
You must be signed in to change notification settings - Fork 4k
/
MentionAutocompleteTextArea.jsx
421 lines (366 loc) · 14.2 KB
/
MentionAutocompleteTextArea.jsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
import { h, Fragment } from 'preact';
import { useState, useEffect, useRef, useLayoutEffect } from 'preact/hooks';
import { forwardRef } from 'preact/compat';
import PropTypes from 'prop-types';
import {
Combobox,
ComboboxInput,
ComboboxPopover,
ComboboxList,
ComboboxOption,
} from '@reach/combobox';
import { UserListItemContent } from './UserListItemContent';
import {
getMentionWordData,
getCursorXY,
useTextAreaAutoResize,
} from '@utilities/textAreaUtils';
import { useMediaQuery, BREAKPOINTS } from '@components/useMediaQuery';
const MIN_SEARCH_CHARACTERS = 2;
const MAX_RESULTS_DISPLAYED = 6;
// Used to ensure dropdown appears just below search text
const DROPDOWN_VERTICAL_OFFSET = '1.5rem';
/**
* Helper function to merge any additional ref passed to the MentionAutocompleteTextArea with the inputRefs used internally by this component.
*
* @param {Array} refs Array of all references
*/
const mergeInputRefs = (refs) => (value) => {
refs.forEach((ref) => {
if (ref) {
ref.current = value;
}
});
};
/**
* Helper function to copy all styles and attributes from the original textarea to new autocomplete textareas before removing the original node
*
* @param {object} options
* @param {element} options.originalNodeToReplace The DOM element that should be replaced
* @param {element} options.plainTextArea The DOM element to be used in the 'non-autosuggest' state. It will receive all attributes and styles of the original node.
* @param {element} options.comboboxTextArea The DOM element to be used in the 'autosuggest' state. It will receive all attributes and styles of the original node.
*/
const replaceTextArea = ({
originalNodeToReplace,
plainTextArea,
comboboxTextArea,
}) => {
const newNodes = [plainTextArea, comboboxTextArea];
const { attributes } = originalNodeToReplace;
const { cssText } = document.defaultView.getComputedStyle(
originalNodeToReplace,
'',
);
newNodes.forEach((node) => {
// Make sure all attributes are copied to the autocomplete & plain textareas
Object.keys(attributes).forEach((attributeKey) => {
node.setAttribute(
attributes[attributeKey].name,
attributes[attributeKey].value,
);
});
// Make sure all styles are copied to the autocomplete & plain textareas
node.style.cssText = cssText;
// Make sure no transition replays when the new textareas are mounted
node.style.transition = 'none';
// Copy any initial value
node.value = originalNodeToReplace.value;
});
// We need to manually remove the original element, as Preact's diffing algorithm won't replace it in render
originalNodeToReplace.remove();
};
/**
* A component for dynamically searching for users and displaying results in a dropdown.
* This component will optionally replace the textarea passed in props, copying all styles and attributes, and allowing for progressive enhancement.
* The component functions by switching between a normal textarea and a combobox textarea. Both textareas receive the attributes and styles of the replaceElement prop, and only one is presented at a time.
* A ref may be given to the component, which will be forwarded to the new textarea
*
* @param {object} props
* @param {element} props.replaceElement The textarea DOM element that should be replaced
* @param {function} props.fetchSuggestions The async call to use for the search
* @param {object} props.inputProps Any additional props to be attached to the textarea element
*
* @example
* <MentionAutocompleteCombobox
* replaceElement={textAreaRef.current}
* fetchSuggestions={fetchUsersByUsername}
* />
*/
export const MentionAutocompleteTextArea = forwardRef(
(
{ replaceElement, fetchSuggestions, autoResize = false, ...inputProps },
forwardedRef,
) => {
const [textContent, setTextContent] = useState(
inputProps.defaultValue ? inputProps.defaultValue : '',
);
const [searchTerm, setSearchTerm] = useState('');
const [cachedSearches, setCachedSearches] = useState({});
const [dropdownPositionPoints, setDropdownPositionPoints] = useState({
x: 0,
y: 0,
});
const [selectionInsertIndex, setSelectionInsertIndex] = useState(0);
const [users, setUsers] = useState([]);
const [cursorPosition, setCursorPosition] = useState(null);
const [ariaHelperText, setAriaHelperText] = useState('');
const [focusable, setFocusable] = useState(false);
const isSmallScreen = useMediaQuery(`(max-width: ${BREAKPOINTS.Small}px)`);
const plainTextAreaRef = useRef(null);
const comboboxRef = useRef(null);
const popoverRef = useRef(null);
const containerRef = useRef(null);
const { setTextArea, setAdditionalElements } = useTextAreaAutoResize();
const {
onChange,
onBlur,
id: inputId,
...autocompleteInputProps
} = inputProps;
useLayoutEffect(() => {
if (autoResize && comboboxRef.current && plainTextAreaRef.current) {
setTextArea(plainTextAreaRef.current);
setAdditionalElements([comboboxRef.current, containerRef.current]);
}
}, [autoResize, setTextArea, setAdditionalElements]);
useEffect(() => {
if (searchTerm.length < MIN_SEARCH_CHARACTERS) {
return;
}
if (cachedSearches[searchTerm]) {
setUsers(cachedSearches[searchTerm]);
return;
}
fetchSuggestions(searchTerm).then(({ result: fetchedUsers }) => {
// If the fetchSuggestion call yields more than the MAX, truncate the results
const resultLength = Math.min(
fetchedUsers.length,
MAX_RESULTS_DISPLAYED,
);
const results = fetchedUsers.slice(0, resultLength);
setCachedSearches({
...cachedSearches,
[searchTerm]: results,
});
setUsers(results);
// Let screen reader users know a list has populated
if (!ariaHelperText && fetchedUsers.length > 0) {
setAriaHelperText(
`Mention user, ${fetchedUsers.length} results found`,
);
}
});
}, [searchTerm, fetchSuggestions, cachedSearches, ariaHelperText]);
useLayoutEffect(() => {
const popover = popoverRef.current;
if (!popover) {
return;
}
const closeOnClickOutsideListener = (event) => {
if (!popover.contains(event.target)) {
// User clicked outside, reset to not searching state
setSearchTerm('');
setAriaHelperText('');
setUsers([]);
const { selectionStart } = comboboxRef.current;
// Switch back to the plain text area
comboboxRef.current.classList.add('hidden');
plainTextAreaRef.current.classList.remove('hidden');
setCursorPosition(selectionStart + 1);
}
};
document.addEventListener('click', closeOnClickOutsideListener);
return () =>
document.removeEventListener('click', closeOnClickOutsideListener);
}, [searchTerm]);
useLayoutEffect(() => {
const { current: plainTextInput } = plainTextAreaRef;
const { current: combobox } = comboboxRef;
const activeInput = combobox.classList.contains('hidden')
? plainTextInput
: combobox;
if (
focusable ||
document.activeElement === combobox ||
document.activeElement === plainTextInput
) {
// Check if the currently focused element is one of the mention autocomplete's
// inputs. This check is necessary to prevent an issue in iOS browsers only.
// An additional check to see if the component can be focusable
// covers the use case for clicking on elements in the mention autocomplete list.
activeInput.focus({ preventScroll: true });
activeInput.setSelectionRange(cursorPosition, cursorPosition - 1);
setFocusable(true);
}
}, [cursorPosition, focusable]);
const handleTextInputChange = ({ target: { value } }) => {
setTextContent(value);
const isComboboxVisible =
!comboboxRef.current.classList.contains('hidden');
const currentActiveInput = isComboboxVisible
? comboboxRef.current
: plainTextAreaRef.current;
const { isUserMention, indexOfMentionStart } =
getMentionWordData(currentActiveInput);
const { selectionStart } = currentActiveInput;
if (isUserMention) {
// search term begins after the @ character
const searchTermStartPosition = indexOfMentionStart + 1;
const mentionText = value.substring(
searchTermStartPosition,
selectionStart,
);
const { x: cursorX, y } = getCursorXY(
currentActiveInput,
indexOfMentionStart,
);
const textAreaX = currentActiveInput.offsetLeft;
// On small screens always show dropdown at start of textarea
const dropdownX = isSmallScreen ? textAreaX : cursorX;
setDropdownPositionPoints({ x: dropdownX, y });
setSearchTerm(mentionText);
setSelectionInsertIndex(searchTermStartPosition);
if (!isComboboxVisible) {
// This is the start of a fresh search, transfer use from plain textarea to combobox
comboboxRef.current.classList.remove('hidden');
plainTextAreaRef.current.classList.add('hidden');
setCursorPosition(selectionStart + 1);
}
} else if (searchTerm) {
// User has moved away from an in-progress @mention - clear current search
setSearchTerm('');
setAriaHelperText('');
setUsers([]);
if (isComboboxVisible) {
// Search has ended, transfer use from combobox back to plain textarea
comboboxRef.current.classList.add('hidden');
plainTextAreaRef.current.classList.remove('hidden');
setCursorPosition(selectionStart + 1);
}
}
};
const handleComboboxBlur = () => {
// User has left the textarea, exit combobox functionality without refocusing plainTextArea
comboboxRef.current.classList.add('hidden');
plainTextAreaRef.current.classList.remove('hidden');
};
const handleSelect = (username) => {
// Construct the new textArea content with selected username inserted
const textWithSelection = `${textContent.substring(
0,
selectionInsertIndex,
)}${username} ${textContent.substring(
comboboxRef.current.selectionStart,
)}`;
// Clear the current search
setSearchTerm('');
setUsers([]);
setAriaHelperText('');
// Update the text area value
setTextContent(textWithSelection);
// Switch back to the plain text input
comboboxRef.current.classList.add('hidden');
plainTextAreaRef.current.classList.remove('hidden');
// Allow any other attached change event to receive the updated text
onChange?.(textWithSelection);
// Update the cursor to directly after the selection (+2 accounts for the @ sign, and adding a space after the username)
const newCursorPosition = selectionInsertIndex + username.length + 2;
setCursorPosition(newCursorPosition);
};
useLayoutEffect(() => {
const { current: comboboxTextArea } = comboboxRef;
const { current: plainTextArea } = plainTextAreaRef;
if (comboboxTextArea && plainTextArea && replaceElement) {
replaceTextArea({
originalNodeToReplace: replaceElement,
plainTextArea,
comboboxTextArea,
});
plainTextArea.focus({ preventScroll: true });
}
// Initialize the new text areas in the "non-autosuggest" state, hiding the combobox until a search begins
comboboxTextArea.classList.add('hidden');
}, [replaceElement]);
return (
<Fragment>
<div aria-live="polite" class="screen-reader-only">
{ariaHelperText}
</div>
<Combobox
ref={containerRef}
id="combobox-container"
data-testid="autocomplete-wrapper"
onSelect={handleSelect}
className={`crayons-autocomplete${autoResize ? ' h-100' : ''}`}
>
<ComboboxInput
{...autocompleteInputProps}
data-gramm_editor="false"
aria-label="Mention user"
ref={comboboxRef}
value={textContent}
data-mention-autocomplete-active="true"
as="textarea"
autocomplete={false}
onChange={(e) => {
onChange?.(e);
handleTextInputChange(e);
}}
onBlur={(e) => {
onBlur?.(e);
handleComboboxBlur();
}}
/>
<textarea
{...autocompleteInputProps}
data-gramm_editor="false"
id={inputId}
data-mention-autocomplete-active="true"
ref={mergeInputRefs([plainTextAreaRef, forwardedRef])}
onChange={(e) => {
onChange?.(e);
handleTextInputChange(e);
}}
value={textContent}
/>
{searchTerm && (
<ComboboxPopover
ref={popoverRef}
className="crayons-autocomplete__popover absolute"
id="mention-autocomplete-popover"
style={{
top: `calc(${dropdownPositionPoints.y}px + ${DROPDOWN_VERTICAL_OFFSET}`,
left: `${dropdownPositionPoints.x}px`,
}}
>
{users.length > 0 ? (
<ComboboxList>
{users.map((user) => (
<ComboboxOption
key={user.username}
value={user.username}
className="crayons-autocomplete__option flex items-center"
>
<UserListItemContent user={user} />
</ComboboxOption>
))}
</ComboboxList>
) : (
<span className="crayons-autocomplete__empty">
{searchTerm.length >= MIN_SEARCH_CHARACTERS
? 'No results found'
: 'Type to search for a user'}
</span>
)}
</ComboboxPopover>
)}
</Combobox>
</Fragment>
);
},
);
MentionAutocompleteTextArea.propTypes = {
replaceElement: PropTypes.node,
fetchSuggestions: PropTypes.func.isRequired,
autoResize: PropTypes.bool,
};