mirror of
https://github.com/status-im/react-native.git
synced 2025-01-10 01:25:39 +00:00
91e5829419
Summary: Currently only scroll events are send through `sendEvent`, and all of them are can be coalesced. In future (further in the stack) touch events will go through there as well, but they won't support coalescing. In order to ensure js processes touch and scroll events in the same order as they were created, we will flush the coalesced events when we encounter one that cannot be coalesced. public ___ //This diff is part of a larger stack. For high level overview what's going on jump to D2884593.// Reviewed By: nicklockwood Differential Revision: D2884591 fb-gh-sync-id: a3d0e916843265ec57f16aad2f016a79764dcce8
110 lines
3.5 KiB
Objective-C
110 lines
3.5 KiB
Objective-C
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import "RCTBridge.h"
|
|
|
|
typedef NS_ENUM(NSInteger, RCTTextEventType) {
|
|
RCTTextEventTypeFocus,
|
|
RCTTextEventTypeBlur,
|
|
RCTTextEventTypeChange,
|
|
RCTTextEventTypeSubmit,
|
|
RCTTextEventTypeEnd,
|
|
RCTTextEventTypeKeyPress
|
|
};
|
|
|
|
typedef NS_ENUM(NSInteger, RCTScrollEventType) {
|
|
RCTScrollEventTypeStart,
|
|
RCTScrollEventTypeMove,
|
|
RCTScrollEventTypeEnd,
|
|
RCTScrollEventTypeStartDeceleration,
|
|
RCTScrollEventTypeEndDeceleration,
|
|
RCTScrollEventTypeEndAnimation,
|
|
};
|
|
|
|
/**
|
|
* The threshold at which text inputs will start warning that the JS thread
|
|
* has fallen behind (resulting in poor input performance, missed keys, etc.)
|
|
*/
|
|
RCT_EXTERN const NSInteger RCTTextUpdateLagWarningThreshold;
|
|
|
|
/**
|
|
* Takes an input event name and normalizes it to the form that is required
|
|
* by the events system (currently that means starting with the "top" prefix,
|
|
* but that's an implementation detail that may change in future).
|
|
*/
|
|
RCT_EXTERN NSString *RCTNormalizeInputEventName(NSString *eventName);
|
|
|
|
@protocol RCTEvent <NSObject>
|
|
|
|
@required
|
|
|
|
@property (nonatomic, strong, readonly) NSNumber *viewTag;
|
|
@property (nonatomic, copy, readonly) NSString *eventName;
|
|
|
|
- (BOOL)canCoalesce;
|
|
- (id<RCTEvent>)coalesceWithEvent:(id<RCTEvent>)newEvent;
|
|
|
|
// used directly for doing a JS call
|
|
+ (NSString *)moduleDotMethod;
|
|
// must contain only JSON compatible values
|
|
- (NSArray *)arguments;
|
|
|
|
@end
|
|
|
|
|
|
/**
|
|
* This class wraps the -[RCTBridge enqueueJSCall:args:] method, and
|
|
* provides some convenience methods for generating event calls.
|
|
*/
|
|
@interface RCTEventDispatcher : NSObject <RCTBridgeModule>
|
|
|
|
/**
|
|
* Send an application-specific event that does not relate to a specific
|
|
* view, e.g. a navigation or data update notification.
|
|
*/
|
|
- (void)sendAppEventWithName:(NSString *)name body:(id)body;
|
|
|
|
/**
|
|
* Send a device or iOS event that does not relate to a specific view,
|
|
* e.g.rotation, location, keyboard show/hide, background/awake, etc.
|
|
*/
|
|
- (void)sendDeviceEventWithName:(NSString *)name body:(id)body;
|
|
|
|
/**
|
|
* Send a user input event. The body dictionary must contain a "target"
|
|
* parameter, representing the React tag of the view sending the event
|
|
*/
|
|
- (void)sendInputEventWithName:(NSString *)name body:(NSDictionary *)body;
|
|
|
|
/**
|
|
* Send a text input/focus event.
|
|
*/
|
|
- (void)sendTextEventWithType:(RCTTextEventType)type
|
|
reactTag:(NSNumber *)reactTag
|
|
text:(NSString *)text
|
|
key:(NSString *)key
|
|
eventCount:(NSInteger)eventCount;
|
|
|
|
/**
|
|
* Send a pre-prepared event object.
|
|
*
|
|
* If the event can be coalesced it is added to a pool of events that are sent at the beginning of the next js frame.
|
|
* Otherwise if the event cannot be coalesced we first flush the pool of coalesced events and the new event after that.
|
|
*
|
|
* Why it works this way?
|
|
* Making sure js gets events in the right order is crucial for correctly interpreting gestures.
|
|
* Unfortunately we cannot emit all events as they come. If we would do that we would have to emit scroll and touch moved event on every frame,
|
|
* which is too much data to transfer and process on older devices. This is especially bad when js starts lagging behind main thread.
|
|
*/
|
|
- (void)sendEvent:(id<RCTEvent>)event;
|
|
|
|
@end
|