Skip to content

feat: remove 'textInput' event from UserEvent type() #1645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 13, 2024
Merged

feat: remove 'textInput' event from UserEvent type() #1645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9747614
feat: remove 'textInput'
mdjastrzebski Aug 13, 2024
3f9d944
refactor: fix ts, tweak naming
mdjastrzebski Aug 13, 2024
cdc21be
refactor: self-code review
mdjastrzebski Aug 13, 2024
372b555
refactor: self-code review
mdjastrzebski Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions src/user-event/__tests__/__snapshots__/clear.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,30 +331,6 @@ How are you?" multiline: true, 1`] = `
"timeStamp": 0,
},
},
{
"name": "textInput",
"payload": {
"currentTarget": {},
"isDefaultPrevented": [Function],
"isPersistent": [Function],
"isPropagationStopped": [Function],
"nativeEvent": {
"previousText": "Hello World!
How are you?",
"range": {
"end": 0,
"start": 0,
},
"target": 0,
"text": "",
},
"persist": [Function],
"preventDefault": [Function],
"stopPropagation": [Function],
"target": {},
"timeStamp": 0,
},
},
{
"name": "change",
"payload": {
Expand Down
3 changes: 0 additions & 3 deletions src/user-event/__tests__/clear.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ function renderTextInputWithToolkit(props: TextInputProps = {}) {
onChange={logEvent('change')}
onChangeText={logEvent('changeText')}
onKeyPress={logEvent('keyPress')}
/** @ts-expect-error property typedef removed in RN 0.75 */
onTextInput={logEvent('textInput')}
onSelectionChange={logEvent('selectionChange')}
onSubmitEditing={logEvent('submitEditing')}
onEndEditing={logEvent('endEditing')}
Expand Down Expand Up @@ -142,7 +140,6 @@ describe('clear()', () => {
'focus',
'selectionChange',
'keyPress',
'textInput',
'change',
'changeText',
'selectionChange',
Expand Down
12 changes: 5 additions & 7 deletions src/user-event/clear.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,23 @@ export async function clear(this: UserEventInstance, element: ReactTestInstance)
dispatchEvent(element, 'focus', EventBuilder.Common.focus());

// 2. Select all
const previousText = element.props.value ?? element.props.defaultValue ?? '';
const textToClear = element.props.value ?? element.props.defaultValue ?? '';
const selectionRange = {
start: 0,
end: previousText.length,
end: textToClear.length,
};
dispatchEvent(element, 'selectionChange', EventBuilder.TextInput.selectionChange(selectionRange));

// 3. Press backspace with selected text
const finalText = '';
const emptyText = '';
await emitTypingEvents(element, {
config: this.config,
key: 'Backspace',
text: finalText,
previousText,
text: emptyText,
});

// 4. Exit element
await wait(this.config);
dispatchEvent(element, 'endEditing', EventBuilder.TextInput.endEditing(finalText));

dispatchEvent(element, 'endEditing', EventBuilder.TextInput.endEditing(emptyText));
dispatchEvent(element, 'blur', EventBuilder.Common.blur());
}
17 changes: 0 additions & 17 deletions src/user-event/event-builder/text-input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,23 +63,6 @@ export const TextInputEventBuilder = {
};
},

/**
* Experimental values:
* - iOS: `{"eventCount": 2, "previousText": "Te", "range": {"end": 2, "start": 2}, "target": 75, "text": "s"}`
* - Android: `{"previousText": "Te", "range": {"end": 2, "start": 0}, "target": 53, "text": "Tes"}`
*/
textInput: (text: string, previousText: string) => {
return {
...baseSyntheticEvent(),
nativeEvent: {
text,
previousText,
range: { start: text.length, end: text.length },
target: 0,
},
};
},

/**
* Experimental values:
* - iOS: `{"contentSize": {"height": 21.666666666666668, "width": 11.666666666666666}, "target": 75}`
Expand Down
50 changes: 0 additions & 50 deletions src/user-event/type/__tests__/__snapshots__/type.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,30 +843,6 @@ exports[`type() supports multiline: input: "{Enter}\\n", multiline: true 1`] = `
"timeStamp": 0,
},
},
{
"name": "textInput",
"payload": {
"currentTarget": {},
"isDefaultPrevented": [Function],
"isPersistent": [Function],
"isPropagationStopped": [Function],
"nativeEvent": {
"previousText": "",
"range": {
"end": 1,
"start": 1,
},
"target": 0,
"text": "
",
},
"persist": [Function],
"preventDefault": [Function],
"stopPropagation": [Function],
"target": {},
"timeStamp": 0,
},
},
{
"name": "change",
"payload": {
Expand Down Expand Up @@ -950,32 +926,6 @@ exports[`type() supports multiline: input: "{Enter}\\n", multiline: true 1`] = `
"timeStamp": 0,
},
},
{
"name": "textInput",
"payload": {
"currentTarget": {},
"isDefaultPrevented": [Function],
"isPersistent": [Function],
"isPropagationStopped": [Function],
"nativeEvent": {
"previousText": "
",
"range": {
"end": 2,
"start": 2,
},
"target": 0,
"text": "

",
},
"persist": [Function],
"preventDefault": [Function],
"stopPropagation": [Function],
"target": {},
"timeStamp": 0,
},
},
{
"name": "change",
"payload": {
Expand Down
2 changes: 0 additions & 2 deletions src/user-event/type/__tests__/type-managed.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ function ManagedTextInput({
onPressOut={logEvent('pressOut')}
onChange={logEvent('change')}
onKeyPress={logEvent('keyPress')}
/** @ts-expect-error property typedef removed in RN 0.75 */
onTextInput={logEvent('textInput')}
onSelectionChange={logEvent('selectionChange')}
onSubmitEditing={logEvent('submitEditing')}
onEndEditing={logEvent('endEditing')}
Expand Down
4 changes: 0 additions & 4 deletions src/user-event/type/__tests__/type.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ function renderTextInputWithToolkit(props: TextInputProps = {}) {
onChange={logEvent('change')}
onChangeText={logEvent('changeText')}
onKeyPress={logEvent('keyPress')}
/** @ts-expect-error property typedef removed in RN 0.75 */
onTextInput={logEvent('textInput')}
onSelectionChange={logEvent('selectionChange')}
onSubmitEditing={logEvent('submitEditing')}
onEndEditing={logEvent('endEditing')}
Expand Down Expand Up @@ -173,13 +171,11 @@ describe('type()', () => {
'focus',
'pressOut',
'keyPress',
'textInput',
'change',
'changeText',
'selectionChange',
'contentSizeChange',
'keyPress',
'textInput',
'change',
'changeText',
'selectionChange',
Expand Down
10 changes: 1 addition & 9 deletions src/user-event/type/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ export async function type(
config: this.config,
key,
text: currentText,
previousText,
isAccepted,
});
}
Expand All @@ -76,13 +75,12 @@ type EmitTypingEventsContext = {
config: UserEventConfig;
key: string;
text: string;
previousText: string;
isAccepted?: boolean;
};

export async function emitTypingEvents(
element: ReactTestInstance,
{ config, key, text, previousText, isAccepted }: EmitTypingEventsContext,
{ config, key, text, isAccepted }: EmitTypingEventsContext,
) {
const isMultiline = element.props.multiline === true;

Expand All @@ -96,12 +94,6 @@ export async function emitTypingEvents(
return;
}

// According to the docs only multiline TextInput emits textInput event
// @see: https://github.com/facebook/react-native/blob/42a2898617da1d7a98ef574a5b9e500681c8f738/packages/react-native/Libraries/Components/TextInput/TextInput.d.ts#L754
if (isMultiline) {
dispatchEvent(element, 'textInput', EventBuilder.TextInput.textInput(text, previousText));
}

dispatchEvent(element, 'change', EventBuilder.TextInput.change(text));
dispatchEvent(element, 'changeText', text);

Expand Down
Loading