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

Add React.unstable_createEventComponent #15580

Merged
merged 1 commit into from May 7, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions packages/react-dom/src/client/ReactDOMHostConfig.js
Expand Up @@ -899,9 +899,6 @@ export function mountEventComponent(
const rootContainerInstance = ((eventComponentInstance.rootInstance: any): Container);
const rootElement = rootContainerInstance.ownerDocument;
const responder = eventComponentInstance.responder;
if (__DEV__) {
Object.freeze(responder);
}
const {rootEventTypes, targetEventTypes} = responder;
if (targetEventTypes !== undefined) {
listenToEventResponderEventTypes(targetEventTypes, rootElement);
Expand Down
11 changes: 4 additions & 7 deletions packages/react-events/README.md
Expand Up @@ -12,16 +12,13 @@ can be found [here](./docs).

## EventComponent

An Event Component is defined by a module that exports an object of the
following type:
An Event Component is defined using `React.unstable_createEventComponent`:

```js
type EventComponent = {|
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName?: string,
props: null | Object,
const EventComponent = React.unstable_createEventComponent(
responder: EventResponder,
|};
displayName: string
);
```

## EventResponder
Expand Down
5 changes: 4 additions & 1 deletion packages/react-events/package.json
Expand Up @@ -35,9 +35,12 @@
"dependencies": {
"loose-envify": "^1.1.0"
},
"peerDependencies": {
"react": "^16.0.0"
},
"browserify": {
"transform": [
"loose-envify"
]
}
}
}
10 changes: 3 additions & 7 deletions packages/react-events/src/Drag.js
Expand Up @@ -11,7 +11,8 @@ import type {
ReactResponderEvent,
ReactResponderContext,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';

const targetEventTypes = ['pointerdown'];
const rootEventTypes = [
Expand Down Expand Up @@ -244,9 +245,4 @@ const DragResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'Drag',
props: null,
responder: DragResponder,
};
export default React.unstable_createEventComponent(DragResponder, 'Drag');
10 changes: 3 additions & 7 deletions packages/react-events/src/Focus.js
Expand Up @@ -11,7 +11,8 @@ import type {
ReactResponderEvent,
ReactResponderContext,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';
import {getEventCurrentTarget} from './utils.js';

type FocusProps = {
Expand Down Expand Up @@ -260,9 +261,4 @@ const FocusResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'Focus',
props: null,
responder: FocusResponder,
};
export default React.unstable_createEventComponent(FocusResponder, 'Focus');
13 changes: 6 additions & 7 deletions packages/react-events/src/FocusScope.js
Expand Up @@ -11,7 +11,8 @@ import type {
ReactResponderEvent,
ReactResponderContext,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';

type FocusScopeProps = {
autoFocus: Boolean,
Expand Down Expand Up @@ -179,9 +180,7 @@ const FocusScopeResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'FocusScope',
props: null,
responder: FocusScopeResponder,
};
export default React.unstable_createEventComponent(
FocusScopeResponder,
'FocusScope',
);
10 changes: 3 additions & 7 deletions packages/react-events/src/Hover.js
Expand Up @@ -11,7 +11,8 @@ import type {
ReactResponderEvent,
ReactResponderContext,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';
import {
getEventPointerType,
getEventCurrentTarget,
Expand Down Expand Up @@ -361,9 +362,4 @@ const HoverResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'Hover',
props: null,
responder: HoverResponder,
};
export default React.unstable_createEventComponent(HoverResponder, 'Hover');
11 changes: 4 additions & 7 deletions packages/react-events/src/Press.js
Expand Up @@ -12,7 +12,9 @@ import type {
ReactResponderContext,
ReactResponderDispatchEventOptions,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';

import {
getEventPointerType,
getEventCurrentTarget,
Expand Down Expand Up @@ -740,9 +742,4 @@ const PressResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'Press',
props: null,
responder: PressResponder,
};
export default React.unstable_createEventComponent(PressResponder, 'Press');
10 changes: 3 additions & 7 deletions packages/react-events/src/Swipe.js
Expand Up @@ -11,7 +11,8 @@ import type {
ReactResponderEvent,
ReactResponderContext,
} from 'shared/ReactTypes';
import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

import React from 'react';

const targetEventTypes = ['pointerdown'];
const rootEventTypes = [
Expand Down Expand Up @@ -254,9 +255,4 @@ const SwipeResponder = {
},
};

export default {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: 'Swipe',
props: null,
responder: SwipeResponder,
};
export default React.unstable_createEventComponent(SwipeResponder, 'Swipe');
6 changes: 6 additions & 0 deletions packages/react/src/React.js
Expand Up @@ -15,6 +15,7 @@ import {
} from 'shared/ReactSymbols';

import {Component, PureComponent} from './ReactBaseClasses';
import {createEventComponent} from './ReactCreateEventComponent';
import {createRef} from './ReactCreateRef';
import {forEach, map, count, toArray, only} from './ReactChildren';
import {
Expand Down Expand Up @@ -51,6 +52,7 @@ import {
import ReactSharedInternals from './ReactSharedInternals';
import {error, warn} from './withComponentStack';
import {
enableEventAPI,
enableStableConcurrentModeAPIs,
enableJSXTransformAPI,
} from 'shared/ReactFeatureFlags';
Expand Down Expand Up @@ -109,6 +111,10 @@ const React = {
// don't modify the React object to avoid deopts.
// Also let's not expose their names in stable builds.

if (enableEventAPI) {
React.unstable_createEventComponent = createEventComponent;
}

if (enableStableConcurrentModeAPIs) {
React.ConcurrentMode = REACT_CONCURRENT_MODE_TYPE;
React.unstable_ConcurrentMode = undefined;
Expand Down
33 changes: 33 additions & 0 deletions packages/react/src/ReactCreateEventComponent.js
@@ -0,0 +1,33 @@
/**
* 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.
* @flow
*/

import type {ReactEventComponent, ReactEventResponder} from 'shared/ReactTypes';
import {enableEventAPI} from 'shared/ReactFeatureFlags';

import {REACT_EVENT_COMPONENT_TYPE} from 'shared/ReactSymbols';

export function createEventComponent(
responder: ReactEventResponder,
displayName: string,
): ?ReactEventComponent {
if (enableEventAPI) {
if (__DEV__) {
Object.freeze(responder);
}
const eventComponent = {
$$typeof: REACT_EVENT_COMPONENT_TYPE,
displayName: displayName,
props: null,
responder: responder,
};
if (__DEV__) {
Object.freeze(eventComponent);
}
return eventComponent;
}
}
12 changes: 6 additions & 6 deletions scripts/rollup/bundles.js
Expand Up @@ -489,7 +489,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/press',
global: 'ReactEventsPress',
externals: [],
externals: ['react'],
},

{
Expand All @@ -504,7 +504,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/hover',
global: 'ReactEventsHover',
externals: [],
externals: ['react'],
},

{
Expand All @@ -519,7 +519,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/focus',
global: 'ReactEventsFocus',
externals: [],
externals: ['react'],
},

{
Expand All @@ -534,7 +534,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/focus-scope',
global: 'ReactEventsFocusScope',
externals: [],
externals: ['react'],
},

{
Expand All @@ -549,7 +549,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/swipe',
global: 'ReactEventsSwipe',
externals: [],
externals: ['react'],
},

{
Expand All @@ -564,7 +564,7 @@ const bundles = [
moduleType: NON_FIBER_RENDERER,
entry: 'react-events/drag',
global: 'ReactEventsDrag',
externals: [],
externals: ['react'],
},
];

Expand Down