Skip to content

feat: prevent events on disabled elements #460

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 7 commits into from
Jul 28, 2020
Merged
Show file tree
Hide file tree
Changes from 5 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
61 changes: 61 additions & 0 deletions src/__tests__/fireEvent.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import React from 'react';
import {
View,
TouchableOpacity,
Pressable,
Text,
ScrollView,
TextInput,
Expand Down Expand Up @@ -163,3 +164,63 @@ test('event with multiple handler parameters', () => {

expect(handlePress).toHaveBeenCalledWith('param1', 'param2');
});

test('should not fire on disabled TouchableOpacity', () => {
const handlePress = jest.fn();
const screen = render(
<TouchableOpacity onPress={handlePress} disabled={true}>
<Text>Trigger</Text>
</TouchableOpacity>
);

expect(() => fireEvent.press(screen.getByText('Trigger'))).toThrow(
'No handler function found for event: "press"'
);
expect(handlePress).not.toHaveBeenCalled();
});

test('should not fire on disabled Pressable', () => {
const handlePress = jest.fn();
const screen = render(
<Pressable onPress={handlePress} disabled={true}>
<Text>Trigger</Text>
</Pressable>
);

expect(() => fireEvent.press(screen.getByText('Trigger'))).toThrow(
'No handler function found for event: "press"'
);
expect(handlePress).not.toHaveBeenCalled();
});

test('should pass event up on disabled TouchableOpacity', () => {
const handleInnerPress = jest.fn();
const handleOuterPress = jest.fn();
const screen = render(
<TouchableOpacity onPress={handleOuterPress}>
<TouchableOpacity onPress={handleInnerPress} disabled={true}>
<Text>Inner Trigger</Text>
</TouchableOpacity>
</TouchableOpacity>
);

fireEvent.press(screen.getByText('Inner Trigger'));
expect(handleInnerPress).not.toHaveBeenCalled();
expect(handleOuterPress).toHaveBeenCalledTimes(1);
});

test('should pass event up on disabled Pressable', () => {
const handleInnerPress = jest.fn();
const handleOuterPress = jest.fn();
const screen = render(
<Pressable onPress={handleOuterPress}>
<Pressable onPress={handleInnerPress} disabled={true}>
<Text>Inner Trigger</Text>
</Pressable>
</Pressable>
);

fireEvent.press(screen.getByText('Inner Trigger'));
expect(handleInnerPress).not.toHaveBeenCalled();
expect(handleOuterPress).toHaveBeenCalledTimes(1);
});
18 changes: 12 additions & 6 deletions src/fireEvent.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ import { ErrorWithStack } from './helpers/errors';
const findEventHandler = (
element: ReactTestInstance,
eventName: string,
callsite?: any
callsite?: any,
nearestHostDescendent?: ReactTestInstance
) => {
const eventHandler = toEventHandlerName(eventName);
const isHostComponent = typeof element.type === 'string';
const hostElement = isHostComponent ? element : nearestHostDescendent;
const isEventEnabled =
hostElement?.props.onStartShouldSetResponder?.() !== false;

const eventHandlerName = toEventHandlerName(eventName);

if (typeof element.props[eventHandler] === 'function') {
return element.props[eventHandler];
} else if (typeof element.props[eventName] === 'function') {
if (typeof element.props[eventHandlerName] === 'function' && isEventEnabled) {
return element.props[eventHandlerName];
} else if (typeof element.props[eventName] === 'function' && isEventEnabled) {
return element.props[eventName];
}

Expand All @@ -23,7 +29,7 @@ const findEventHandler = (
);
}

return findEventHandler(element.parent, eventName, callsite);
return findEventHandler(element.parent, eventName, callsite, hostElement);
};

const invokeEvent = (
Expand Down