Skip to content
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

Rename hover props in experimental event API and write unit tests #15283

Merged
merged 2 commits into from
Apr 1, 2019
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
30 changes: 15 additions & 15 deletions packages/react-events/src/Hover.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ if (typeof window !== 'undefined' && window.PointerEvent === undefined) {
targetEventTypes.push('touchstart', 'mouseover', 'mouseout');
}

function dispatchHoverInEvents(
function dispatchHoverStartEvents(
context: EventResponderContext,
props: Object,
state: HoverState,
): void {
const {event, eventTarget} = context;
if (context.isTargetWithinEventComponent((event: any).relatedTarget)) {
return;
}
if (props.onHoverStart) {
context.dispatchEvent('hoverstart', props.onHoverStart, eventTarget, true);
}
if (props.onHoverChange) {
if (context.isTargetWithinEventComponent((event: any).relatedTarget)) {
return;
}
if (props.onHoverIn) {
context.dispatchEvent('hoverin', props.onHoverIn, eventTarget, true);
}
const hoverChangeEventListener = () => {
props.onHoverChange(true);
};
Expand All @@ -54,13 +54,13 @@ function dispatchHoverInEvents(
}
}

function dispatchHoverOutEvents(context: EventResponderContext, props: Object) {
function dispatchHoverEndEvents(context: EventResponderContext, props: Object) {
const {event, eventTarget} = context;
if (context.isTargetWithinEventComponent((event: any).relatedTarget)) {
return;
}
if (props.onHoverOut) {
context.dispatchEvent('hoverout', props.onHoverOut, eventTarget, true);
if (props.onHoverEnd) {
context.dispatchEvent('hoverend', props.onHoverEnd, eventTarget, true);
}
if (props.onHoverChange) {
const hoverChangeEventListener = () => {
Expand Down Expand Up @@ -118,15 +118,15 @@ const HoverResponder = {
state.isInHitSlop = true;
return;
}
dispatchHoverInEvents(context, props, state);
dispatchHoverStartEvents(context, props, state);
state.isHovered = true;
}
break;
}
case 'pointerout':
case 'mouseout': {
if (state.isHovered && !state.isTouched) {
dispatchHoverOutEvents(context, props);
dispatchHoverEndEvents(context, props);
state.isHovered = false;
}
state.isInHitSlop = false;
Expand All @@ -142,7 +142,7 @@ const HoverResponder = {
(event: any).y,
)
) {
dispatchHoverInEvents(context, props, state);
dispatchHoverStartEvents(context, props, state);
state.isHovered = true;
state.isInHitSlop = false;
}
Expand All @@ -153,7 +153,7 @@ const HoverResponder = {
(event: any).y,
)
) {
dispatchHoverOutEvents(context, props);
dispatchHoverEndEvents(context, props);
state.isHovered = false;
state.isInHitSlop = true;
}
Expand All @@ -162,7 +162,7 @@ const HoverResponder = {
}
case 'pointercancel': {
if (state.isHovered && !state.isTouched) {
dispatchHoverOutEvents(context, props);
dispatchHoverEndEvents(context, props);
state.isHovered = false;
state.isTouched = false;
}
Expand Down
102 changes: 102 additions & 0 deletions packages/react-events/src/__tests__/Hover-test.internal.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @emails react-core
*/

'use strict';

let React;
let ReactFeatureFlags;
let ReactDOM;
let Hover;

describe('Hover event responder', () => {
let container;

beforeEach(() => {
jest.resetModules();
ReactFeatureFlags = require('shared/ReactFeatureFlags');
ReactFeatureFlags.enableEventAPI = true;
React = require('react');
ReactDOM = require('react-dom');
Hover = require('react-events/hover');

container = document.createElement('div');
document.body.appendChild(container);
});

afterEach(() => {
document.body.removeChild(container);
container = null;
});

it('should support onHover', () => {
let divRef = React.createRef();
let events = [];

function handleOnHover(e) {
if (e) {
events.push('hover in');
} else {
events.push('hover out');
}
}

function Component() {
return (
<Hover onHoverChange={handleOnHover}>
<div ref={divRef}>Hover me!</div>
</Hover>
);
}

ReactDOM.render(<Component />, container);

const mouseOverEvent = document.createEvent('Event');
mouseOverEvent.initEvent('mouseover', true, true);
divRef.current.dispatchEvent(mouseOverEvent);

const mouseOutEvent = document.createEvent('Event');
mouseOutEvent.initEvent('mouseout', true, true);
divRef.current.dispatchEvent(mouseOutEvent);

expect(events).toEqual(['hover in', 'hover out']);
});

it('should support onHoverStart and onHoverEnd', () => {
let divRef = React.createRef();
let events = [];

function handleOnHoverStart() {
events.push('onHoverStart');
}

function handleOnHoverEnd() {
events.push('onHoverEnd');
}

function Component() {
return (
<Hover onHoverStart={handleOnHoverStart} onHoverEnd={handleOnHoverEnd}>
<div ref={divRef}>Hover me!</div>
</Hover>
);
}

ReactDOM.render(<Component />, container);

const mouseOverEvent = document.createEvent('Event');
mouseOverEvent.initEvent('mouseover', true, true);
divRef.current.dispatchEvent(mouseOverEvent);

const mouseOutEvent = document.createEvent('Event');
mouseOutEvent.initEvent('mouseout', true, true);
divRef.current.dispatchEvent(mouseOutEvent);

expect(events).toEqual(['onHoverStart', 'onHoverEnd']);
});
});