TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
164 lines
7.6 KiB
Plaintext
164 lines
7.6 KiB
Plaintext
/*
|
|
* Copyright 2021 Adobe. All rights reserved.
|
|
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License. You may obtain a copy
|
|
* of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software distributed under
|
|
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
* governing permissions and limitations under the License.
|
|
*/
|
|
|
|
import {AriaTextFieldProps} from '@react-types/textfield';
|
|
import {mergeProps, useEffectEvent} from '@react-aria/utils';
|
|
import {RefObject} from '@react-types/shared';
|
|
import {TextFieldAria, useTextField} from './useTextField';
|
|
import {useEffect, useRef} from 'react';
|
|
|
|
interface FormattedTextFieldState {
|
|
validate: (val: string) => boolean,
|
|
setInputValue: (val: string) => void
|
|
}
|
|
|
|
|
|
function supportsNativeBeforeInputEvent() {
|
|
return typeof window !== 'undefined' &&
|
|
window.InputEvent &&
|
|
typeof InputEvent.prototype.getTargetRanges === 'function';
|
|
}
|
|
|
|
export function useFormattedTextField(props: AriaTextFieldProps, state: FormattedTextFieldState, inputRef: RefObject<HTMLInputElement | null>): TextFieldAria {
|
|
// All browsers implement the 'beforeinput' event natively except Firefox
|
|
// (currently behind a flag as of Firefox 84). React's polyfill does not
|
|
// run in all cases that the native event fires, e.g. when deleting text.
|
|
// Use the native event if available so that we can prevent invalid deletions.
|
|
// We do not attempt to polyfill this in Firefox since it would be very complicated,
|
|
// the benefit of doing so is fairly minor, and it's going to be natively supported soon.
|
|
let onBeforeInputFallback = useEffectEvent((e: InputEvent) => {
|
|
let input = inputRef.current;
|
|
if (!input) {
|
|
return;
|
|
}
|
|
|
|
// Compute the next value of the input if the event is allowed to proceed.
|
|
// See https://www.w3.org/TR/input-events-2/#interface-InputEvent-Attributes for a full list of input types.
|
|
let nextValue: string | null = null;
|
|
switch (e.inputType) {
|
|
case 'historyUndo':
|
|
case 'historyRedo':
|
|
// Explicitly allow undo/redo. e.data is null in this case, but there's no need to validate,
|
|
// because presumably the input would have already been validated previously.
|
|
return;
|
|
case 'insertLineBreak':
|
|
// Explicitly allow "insertLineBreak" event, to allow onSubmit for "enter" key. e.data is null in this case.
|
|
return;
|
|
case 'deleteContent':
|
|
case 'deleteByCut':
|
|
case 'deleteByDrag':
|
|
nextValue = input.value.slice(0, input.selectionStart!) + input.value.slice(input.selectionEnd!);
|
|
break;
|
|
case 'deleteContentForward':
|
|
// This is potentially incorrect, since the browser may actually delete more than a single UTF-16
|
|
// character. In reality, a full Unicode grapheme cluster consisting of multiple UTF-16 characters
|
|
// or code points may be deleted. However, in our currently supported locales, there are no such cases.
|
|
// If we support additional locales in the future, this may need to change.
|
|
nextValue = input.selectionEnd === input.selectionStart
|
|
? input.value.slice(0, input.selectionStart!) + input.value.slice(input.selectionEnd! + 1)
|
|
: input.value.slice(0, input.selectionStart!) + input.value.slice(input.selectionEnd!);
|
|
break;
|
|
case 'deleteContentBackward':
|
|
nextValue = input.selectionEnd === input.selectionStart
|
|
? input.value.slice(0, input.selectionStart! - 1) + input.value.slice(input.selectionStart!)
|
|
: input.value.slice(0, input.selectionStart!) + input.value.slice(input.selectionEnd!);
|
|
break;
|
|
case 'deleteSoftLineBackward':
|
|
case 'deleteHardLineBackward':
|
|
nextValue = input.value.slice(input.selectionStart!);
|
|
break;
|
|
default:
|
|
if (e.data != null) {
|
|
nextValue =
|
|
input.value.slice(0, input.selectionStart!) +
|
|
e.data +
|
|
input.value.slice(input.selectionEnd!);
|
|
}
|
|
break;
|
|
}
|
|
|
|
// If we did not compute a value, or the new value is invalid, prevent the event
|
|
// so that the browser does not update the input text, move the selection, or add to
|
|
// the undo/redo stack.
|
|
if (nextValue == null || !state.validate(nextValue)) {
|
|
e.preventDefault();
|
|
}
|
|
});
|
|
|
|
useEffect(() => {
|
|
if (!supportsNativeBeforeInputEvent() || !inputRef.current) {
|
|
return;
|
|
}
|
|
|
|
let input = inputRef.current;
|
|
input.addEventListener('beforeinput', onBeforeInputFallback, false);
|
|
return () => {
|
|
input.removeEventListener('beforeinput', onBeforeInputFallback, false);
|
|
};
|
|
}, [inputRef, onBeforeInputFallback]);
|
|
|
|
let onBeforeInput = !supportsNativeBeforeInputEvent()
|
|
? e => {
|
|
let nextValue =
|
|
e.target.value.slice(0, e.target.selectionStart) +
|
|
e.data +
|
|
e.target.value.slice(e.target.selectionEnd);
|
|
|
|
if (!state.validate(nextValue)) {
|
|
e.preventDefault();
|
|
}
|
|
}
|
|
: null;
|
|
|
|
let {labelProps, inputProps: textFieldProps, descriptionProps, errorMessageProps, ...validation} = useTextField(props, inputRef);
|
|
|
|
let compositionStartState = useRef<{value: string, selectionStart: number | null, selectionEnd: number | null} | null>(null);
|
|
return {
|
|
inputProps: mergeProps(
|
|
textFieldProps,
|
|
{
|
|
onBeforeInput,
|
|
onCompositionStart() {
|
|
// Chrome does not implement Input Events Level 2, which specifies the insertFromComposition
|
|
// and deleteByComposition inputType values for the beforeinput event. These are meant to occur
|
|
// at the end of a composition (e.g. Pinyin IME, Android auto correct, etc.), and crucially, are
|
|
// cancelable. The insertCompositionText and deleteCompositionText input types are not cancelable,
|
|
// nor would we want to cancel them because the input from the user is incomplete at that point.
|
|
// In Safari, insertFromComposition/deleteFromComposition will fire, however, allowing us to cancel
|
|
// the final composition result if it is invalid. As a fallback for Chrome and Firefox, which either
|
|
// don't support Input Events Level 2, or beforeinput at all, we store the state of the input when
|
|
// the compositionstart event fires, and undo the changes in compositionend (below) if it is invalid.
|
|
// Unfortunately, this messes up the undo/redo stack, but until insertFromComposition/deleteByComposition
|
|
// are implemented, there is no other way to prevent composed input.
|
|
// See https://bugs.chromium.org/p/chromium/issues/detail?id=1022204
|
|
let {value, selectionStart, selectionEnd} = inputRef.current!;
|
|
compositionStartState.current = {value, selectionStart, selectionEnd};
|
|
},
|
|
onCompositionEnd() {
|
|
if (inputRef.current && !state.validate(inputRef.current.value)) {
|
|
// Restore the input value in the DOM immediately so we can synchronously update the selection position.
|
|
// But also update the value in React state as well so it is correct for future updates.
|
|
let {value, selectionStart, selectionEnd} = compositionStartState.current!;
|
|
inputRef.current.value = value;
|
|
inputRef.current.setSelectionRange(selectionStart, selectionEnd);
|
|
state.setInputValue(value);
|
|
}
|
|
}
|
|
}
|
|
),
|
|
labelProps,
|
|
descriptionProps,
|
|
errorMessageProps,
|
|
...validation
|
|
};
|
|
}
|