Skip to content

Forward extra data to press event #828

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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions src/__tests__/fireEvent.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,19 @@ describe('fireEvent', () => {
test('fireEvent.press', () => {
const onPressMock = jest.fn();
const text = 'Fireevent press';
const eventData = {
nativeEvent: {
pageX: 20,
pageY: 30,
},
};
const { getByText } = render(
<OnPressComponent onPress={onPressMock} text={text} />
);

fireEvent.press(getByText(text));
fireEvent.press(getByText(text), eventData);

expect(onPressMock).toHaveBeenCalled();
expect(onPressMock).toHaveBeenCalledWith(eventData);
});

test('fireEvent.scroll', () => {
Expand Down
4 changes: 2 additions & 2 deletions src/fireEvent.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ const invokeEvent = (
const toEventHandlerName = (eventName: string) =>
`on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;

const pressHandler = (element: ReactTestInstance): void =>
invokeEvent(element, 'press', pressHandler);
const pressHandler = (element: ReactTestInstance, ...data: Array<any>): void =>
invokeEvent(element, 'press', pressHandler, ...data);
const changeTextHandler = (
element: ReactTestInstance,
...data: Array<any>
Expand Down
2 changes: 1 addition & 1 deletion typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ export type FireEventFunction = (
) => any;

export type FireEventAPI = FireEventFunction & {
press: (element: ReactTestInstance) => any;
press: (element: ReactTestInstance, ...data: Array<any>) => any;
changeText: (element: ReactTestInstance, ...data: Array<any>) => any;
scroll: (element: ReactTestInstance, ...data: Array<any>) => any;
};
Expand Down
12 changes: 9 additions & 3 deletions website/docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ fireEvent[eventName](element: ReactTestInstance, ...data: Array<any>): void

Convenience methods for common events like: `press`, `changeText`, `scroll`.

### `fireEvent.press: (element: ReactTestInstance) => void`
### `fireEvent.press: (element: ReactTestInstance, ...data: Array<any>) => void`

Invokes `press` event handler on the element or parent element in the tree.

Expand All @@ -234,6 +234,12 @@ import { View, Text, TouchableOpacity } from 'react-native';
import { render, fireEvent } from '@testing-library/react-native';

const onPressMock = jest.fn();
const eventData = {
nativeEvent: {
pageX: 20,
pageY: 30,
},
};

const { getByText } = render(
<View>
Expand All @@ -243,8 +249,8 @@ const { getByText } = render(
</View>
);

fireEvent.press(getByText('Press me'));
expect(onPressMock).toHaveBeenCalled();
fireEvent.press(getByText('Press me'), eventData);
expect(onPressMock).toHaveBeenCalledWith(eventData);
```

### `fireEvent.changeText: (element: ReactTestInstance, ...data: Array<any>) => void`
Expand Down