-
Notifications
You must be signed in to change notification settings - Fork 274
fix: non-editable wrapped TextInput events #1385
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.
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
mdjastrzebski
merged 4 commits into
callstack:main
from
TMaszko:fix/non-editable-wrapped-text-input-events
May 4, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,150 @@ | ||
import React from 'react'; | ||
import { Text, TextInput, TextInputProps } from 'react-native'; | ||
import { render, fireEvent } from '..'; | ||
|
||
function WrappedTextInput(props: TextInputProps) { | ||
return <TextInput {...props} />; | ||
} | ||
|
||
function DoubleWrappedTextInput(props: TextInputProps) { | ||
return <WrappedTextInput {...props} />; | ||
} | ||
|
||
const layoutEvent = { nativeEvent: { layout: { width: 100, height: 100 } } }; | ||
|
||
test('should fire only non-touch-related events on non-editable TextInput', () => { | ||
const onFocus = jest.fn(); | ||
const onChangeText = jest.fn(); | ||
const onSubmitEditing = jest.fn(); | ||
const onLayout = jest.fn(); | ||
|
||
const view = render( | ||
<TextInput | ||
editable={false} | ||
testID="subject" | ||
onFocus={onFocus} | ||
onChangeText={onChangeText} | ||
onSubmitEditing={onSubmitEditing} | ||
onLayout={onLayout} | ||
/> | ||
); | ||
|
||
const subject = view.getByTestId('subject'); | ||
fireEvent(subject, 'focus'); | ||
fireEvent.changeText(subject, 'Text'); | ||
fireEvent(subject, 'submitEditing', { nativeEvent: { text: 'Text' } }); | ||
fireEvent(subject, 'layout', layoutEvent); | ||
|
||
expect(onFocus).not.toHaveBeenCalled(); | ||
expect(onChangeText).not.toHaveBeenCalled(); | ||
expect(onSubmitEditing).not.toHaveBeenCalled(); | ||
expect(onLayout).toHaveBeenCalledWith(layoutEvent); | ||
}); | ||
|
||
test('should fire only non-touch-related events on non-editable TextInput with nested Text', () => { | ||
const onFocus = jest.fn(); | ||
const onChangeText = jest.fn(); | ||
const onSubmitEditing = jest.fn(); | ||
const onLayout = jest.fn(); | ||
|
||
const view = render( | ||
<TextInput | ||
editable={false} | ||
testID="subject" | ||
onFocus={onFocus} | ||
onChangeText={onChangeText} | ||
onSubmitEditing={onSubmitEditing} | ||
onLayout={onLayout} | ||
> | ||
<Text>Nested Text</Text> | ||
</TextInput> | ||
); | ||
|
||
const subject = view.getByText('Nested Text'); | ||
fireEvent(subject, 'focus'); | ||
fireEvent.changeText(subject, 'Text'); | ||
fireEvent(subject, 'submitEditing', { nativeEvent: { text: 'Text' } }); | ||
fireEvent(subject, 'layout', layoutEvent); | ||
|
||
expect(onFocus).not.toHaveBeenCalled(); | ||
expect(onChangeText).not.toHaveBeenCalled(); | ||
expect(onSubmitEditing).not.toHaveBeenCalled(); | ||
expect(onLayout).toHaveBeenCalledWith(layoutEvent); | ||
}); | ||
|
||
/** | ||
* Historically there were problems with custom TextInput wrappers, as they | ||
* could creat a hierarchy of three or more composite text input views with | ||
* very similar event props. | ||
* | ||
* Typical hierarchy would be: | ||
* - User composite TextInput | ||
* - UI library composite TextInput | ||
* - RN composite TextInput | ||
* - RN host TextInput | ||
* | ||
* Previous implementation of fireEvent only checked `editable` prop for | ||
* RN TextInputs, both host & composite but did not check on the UI library or | ||
* user composite TextInput level, hence invoking the event handlers that | ||
* should be blocked by `editable={false}` prop. | ||
*/ | ||
test('should fire only non-touch-related events on non-editable wrapped TextInput', () => { | ||
const onFocus = jest.fn(); | ||
const onChangeText = jest.fn(); | ||
const onSubmitEditing = jest.fn(); | ||
const onLayout = jest.fn(); | ||
|
||
const view = render( | ||
<WrappedTextInput | ||
editable={false} | ||
testID="subject" | ||
onFocus={onFocus} | ||
onChangeText={onChangeText} | ||
onSubmitEditing={onSubmitEditing} | ||
onLayout={onLayout} | ||
/> | ||
); | ||
|
||
const subject = view.getByTestId('subject'); | ||
fireEvent(subject, 'focus'); | ||
fireEvent.changeText(subject, 'Text'); | ||
fireEvent(subject, 'submitEditing', { nativeEvent: { text: 'Text' } }); | ||
fireEvent(subject, 'layout', layoutEvent); | ||
|
||
expect(onFocus).not.toHaveBeenCalled(); | ||
expect(onChangeText).not.toHaveBeenCalled(); | ||
expect(onSubmitEditing).not.toHaveBeenCalled(); | ||
expect(onLayout).toHaveBeenCalledWith(layoutEvent); | ||
}); | ||
|
||
/** | ||
* Ditto testing for even deeper hierarchy of TextInput wrappers. | ||
*/ | ||
test('should fire only non-touch-related events on non-editable double wrapped TextInput', () => { | ||
const onFocus = jest.fn(); | ||
const onChangeText = jest.fn(); | ||
const onSubmitEditing = jest.fn(); | ||
const onLayout = jest.fn(); | ||
|
||
const view = render( | ||
<DoubleWrappedTextInput | ||
editable={false} | ||
testID="subject" | ||
onFocus={onFocus} | ||
onChangeText={onChangeText} | ||
onSubmitEditing={onSubmitEditing} | ||
onLayout={onLayout} | ||
/> | ||
); | ||
|
||
const subject = view.getByTestId('subject'); | ||
fireEvent(subject, 'focus'); | ||
fireEvent.changeText(subject, 'Text'); | ||
fireEvent(subject, 'submitEditing', { nativeEvent: { text: 'Text' } }); | ||
fireEvent(subject, 'layout', layoutEvent); | ||
|
||
expect(onFocus).not.toHaveBeenCalled(); | ||
expect(onChangeText).not.toHaveBeenCalled(); | ||
expect(onSubmitEditing).not.toHaveBeenCalled(); | ||
expect(onLayout).toHaveBeenCalledWith(layoutEvent); | ||
}); |
This file contains hidden or 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
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.