From 612e935e00aa9845969b711700a2580a7befe228 Mon Sep 17 00:00:00 2001 From: Navneet Kambo <72474613+nakambo@users.noreply.github.com> Date: Fri, 7 Jul 2023 16:12:14 -0700 Subject: [PATCH] [Key handling] pass through all keys; allow specifying modifiers for validKeys[Down|Up] (#1867) (#1866) * [Key handling] pass through all keys; allow specifying modifiers for validKeys[Down|Up] There are scenarios where it might be necessary to look at the incoming events without removing from the system queue. Currently that's impossible today on React Native macOS, since views are required to specify `validKeysDown` or `validKeysUp`, and such events are always removed from the queue. To mitigate, let's add a new `passthroughAllKeyEvents` prop to `RCTView`. We could keep it forever (towards an interest to reduce event spam from native to JS), or we could use it towards the path to making it the default behavior (stage 1: default false, i.e. opt in, stage 2: default true, i.e. opt out, stage 3: remove, is default behavior). - React/Views/RCTView.h - React/Views/RCTView.m - React/Views/RCTViewManager.m Note that this doesn't properly work with `RCTUITextField` (i.e. single line text fields). From what I can tell, that would need us to possibly provide a custom field editor for the window. I am scoping this out for this PR. Another peculiarity to note is regarding `RCTUITextView` (i.e. multi line text fields). Here, it looks like the text view itself isn't exposed to the JS (this view doesn't have a `nativeTag`), so there's a `RCTView` holding a child `RCTUITextView` where the former dispatches events to JS on behalf for the latter. The reason this matters (specifically for "pass through" events) is because the latter can dispatch certain events to the JS, and then depending on the super class implementation (`NSTextView`), it may or may not *also* pass the `NSEvent` to the next responder (i.e. parent view, i.e. `RCTView`). Passing the action to the next responder *can* cause us to send duplicate JS events for the same `NSEvent`. I couldn't find anything in macOS APIs to determine if the view the event was generated for is a specific view, so I am introducing a book-keeping mechanism to not send duplicate events. Introduce `RCTHandledKey` for specifying modifiers for `validKeysDown` and `validKeysUp`. Behavior noted in type definitions. - Libraries/Text/TextInput/RCTBaseTextInputView.m - React/Base/RCTConvert.h - React/Base/RCTConvert.m - React/Views/RCTHandledKey.h - React/Views/RCTHandledKey.m - React/Views/RCTView.h - React/Views/RCTView.m - React/Views/RCTViewKeyboardEvent.m - React/Views/RCTViewManager.m - React/Views/ScrollView/RCTScrollView.m macOS *usually* does things on key down (as opposed to, say, Win32, which seems to *usually* does things on key up). Like `RCTUITextField`, passs `performKeyEquivalent:` to `textInputDelegate` so we can handle the alternate `keyDown:` path (e.g. Cmd+A). This will be needed for properly handling keystrokes that go through said alternate path. There are probably several other selectors that also need implementing (`deleteBackward:`) to full pass through every possible key, but I am leaving that for some other time. - Libraries/Text/TextInput/Multiline/RCTUITextView.m Make a totally unrelated fix to `RCTSwitch`. In a test page where I added an on-by-default switch, I noticed the first toggle (ON->OFF) doesn't do anything. The second toggle (OFF->ON) then doesn't (expectedly) do anything. Found wrong behavior on the switch test page -- tempted to instead remove `wasOn`, but for now repeating the pattern in `setOn:animated:` - React/Views/RCTSwitch.m Flow stuff. `passthroughAllKeyEvents` is now a valid thing to pass to `View` types. - Libraries/Components/View/ReactNativeViewAttributes.js - Libraries/Components/View/ViewPropTypes.js - Libraries/NativeComponent/BaseViewConfig.macos.js Update signatures for `validKeysDown` and `validKeysUp` - Libraries/Components/View/ViewPropTypes.js Remove duplicated specifications on `Pressable`. Just use the one from `View`. As a benefit, future changes allow us to not have to touch `Pressable` anymore. - Libraries/Components/Pressable/Pressable.js - Libraries/Components/View/ViewPropTypes.js Update test pages with `passthoughAllKeyEvents` and the keyboard events page with an example modifier usage. - packages/rn-tester/js/examples/KeyboardEventsExample/KeyboardEventsExample.js - packages/rn-tester/js/examples/TextInput/TextInputSharedExamples.js Testing: * Using the keyboard events test page, validate "pass through" of all events for simple view, single line text input, multi line text input. Sanity test existing (non-"pass through") behavior. * Using the text input test page, ordering of `keyDown` and `keyUp` events w.r.t. other events (such as `keyPress` -- which isn't dispatched for every key) * Using the switch test page, sanity test switch behaviors * feedback * feedback #2 * PR feedback --------- Co-authored-by: Saad Najmi --- Libraries/Components/Pressable/Pressable.js | 24 +- .../View/ReactNativeViewAttributes.js | 1 + Libraries/Components/View/ViewPropTypes.js | 46 ++- .../NativeComponent/BaseViewConfig.macos.js | 1 + .../Text/TextInput/Multiline/RCTUITextView.m | 8 + .../Text/TextInput/RCTBaseTextInputView.m | 4 +- React/Base/RCTConvert.h | 4 + React/Base/RCTConvert.m | 4 + React/Views/RCTHandledKey.h | 40 +++ React/Views/RCTHandledKey.m | 145 +++++++++ React/Views/RCTView.h | 10 +- React/Views/RCTView.m | 56 +++- React/Views/RCTViewKeyboardEvent.m | 19 +- React/Views/RCTViewManager.m | 5 +- React/Views/ScrollView/RCTScrollView.m | 6 +- .../KeyboardEventsExample.js | 278 +++++++++++++----- .../TextInput/TextInputSharedExamples.js | 81 ++++- 17 files changed, 618 insertions(+), 114 deletions(-) create mode 100644 React/Views/RCTHandledKey.h create mode 100644 React/Views/RCTHandledKey.m diff --git a/Libraries/Components/Pressable/Pressable.js b/Libraries/Components/Pressable/Pressable.js index 5a7566e106fe25..5560626ffea930 100644 --- a/Libraries/Components/Pressable/Pressable.js +++ b/Libraries/Components/Pressable/Pressable.js @@ -26,6 +26,7 @@ import type { AccessibilityState, AccessibilityValue, } from '../View/ViewAccessibility'; +import type {HandledKeyboardEvent} from '../View/ViewPropTypes'; // [macOS] import {PressabilityDebugView} from '../../Pressability/PressabilityDebug'; import usePressability from '../../Pressability/usePressability'; @@ -185,16 +186,27 @@ type Props = $ReadOnly<{| onKeyUp?: ?(event: KeyEvent) => void, /** - * Array of keys to receive key down events for - * For arrow keys, add "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown", + * When `true`, allows `onKeyDown` and `onKeyUp` to receive events not specified in + * `validKeysDown` and `validKeysUp`, respectively. Events matching `validKeysDown` and `validKeysUp` + * still have their native default behavior prevented, but the others do not. + * + * @platform macos */ - validKeysDown?: ?Array, + passthroughAllKeyEvents?: ?boolean, /** - * Array of keys to receive key up events for - * For arrow keys, add "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown", + * Array of keys to receive key down events for. These events have their default native behavior prevented. + * + * @platform macos + */ + validKeysDown?: ?Array, + + /** + * Array of keys to receive key up events for. These events have their default native behavior prevented. + * + * @platform macos */ - validKeysUp?: ?Array, + validKeysUp?: ?Array, /** * Specifies whether the view should receive the mouse down event when the diff --git a/Libraries/Components/View/ReactNativeViewAttributes.js b/Libraries/Components/View/ReactNativeViewAttributes.js index 64e6adc28ea3fa..267b74332ed360 100644 --- a/Libraries/Components/View/ReactNativeViewAttributes.js +++ b/Libraries/Components/View/ReactNativeViewAttributes.js @@ -47,6 +47,7 @@ const UIView = { onDrop: true, onKeyDown: true, onKeyUp: true, + passthroughAllKeyEvents: true, validKeysDown: true, validKeysUp: true, draggedTypes: true, diff --git a/Libraries/Components/View/ViewPropTypes.js b/Libraries/Components/View/ViewPropTypes.js index f05c0981431579..fbcf21f7955e14 100644 --- a/Libraries/Components/View/ViewPropTypes.js +++ b/Libraries/Components/View/ViewPropTypes.js @@ -100,22 +100,58 @@ type DirectEventProps = $ReadOnly<{| |}>; // [macOS -type KeyboardEventProps = $ReadOnly<{| +/** + * Represents a key that could be passed to `validKeysDown` and `validKeysUp`. + * + * `key` is the actual key, such as "a", or one of the special values: + * "Tab", "Escape", "Enter", "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown", + * "Backspace", "Delete", "Home", "End", "PageUp", "PageDown". + * + * The rest are modifiers that when absent mean false. + * + * @platform macos + */ +export type HandledKeyboardEvent = $ReadOnly<{| + altKey?: ?boolean, + ctrlKey?: ?boolean, + metaKey?: ?boolean, + shiftKey?: ?boolean, + key: string, +|}>; + +export type KeyboardEventProps = $ReadOnly<{| + /** + * Called after a key down event is detected. + */ onKeyDown?: ?(event: KeyEvent) => void, + + /** + * Called after a key up event is detected. + */ onKeyUp?: ?(event: KeyEvent) => void, + + /** + * When `true`, allows `onKeyDown` and `onKeyUp` to receive events not specified in + * `validKeysDown` and `validKeysUp`, respectively. Events matching `validKeysDown` and `validKeysUp` + * are still removed from the event queue, but the others are not. + * + * @platform macos + */ + passthroughAllKeyEvents?: ?boolean, + /** - * Array of keys to receive key down events for + * Array of keys to receive key down events for. These events have their default native behavior prevented. * * @platform macos */ - validKeysDown?: ?Array, + validKeysDown?: ?Array, /** - * Array of keys to receive key up events for + * Array of keys to receive key up events for. These events have their default native behavior prevented. * * @platform macos */ - validKeysUp?: ?Array, + validKeysUp?: ?Array, |}>; // macOS] diff --git a/Libraries/NativeComponent/BaseViewConfig.macos.js b/Libraries/NativeComponent/BaseViewConfig.macos.js index 3040f72245b909..fd71051f0ce638 100644 --- a/Libraries/NativeComponent/BaseViewConfig.macos.js +++ b/Libraries/NativeComponent/BaseViewConfig.macos.js @@ -52,6 +52,7 @@ const validAttributesForNonEventProps = { draggedTypes: true, enableFocusRing: true, tooltip: true, + passthroughAllKeyEvents: true, validKeysDown: true, validKeysUp: true, mouseDownCanMoveWindow: true, diff --git a/Libraries/Text/TextInput/Multiline/RCTUITextView.m b/Libraries/Text/TextInput/Multiline/RCTUITextView.m index 4c50b98d07a2ea..1601458b22c017 100644 --- a/Libraries/Text/TextInput/Multiline/RCTUITextView.m +++ b/Libraries/Text/TextInput/Multiline/RCTUITextView.m @@ -550,6 +550,14 @@ - (void)deleteBackward { } } #else // [macOS +- (BOOL)performKeyEquivalent:(NSEvent *)event { + if (!self.hasMarkedText && ![self.textInputDelegate textInputShouldHandleKeyEvent:event]) { + return YES; + } + + return [super performKeyEquivalent:event]; +} + - (void)keyDown:(NSEvent *)event { // If has marked text, handle by native and return // Do this check before textInputShouldHandleKeyEvent as that one attempts to send the event to JS diff --git a/Libraries/Text/TextInput/RCTBaseTextInputView.m b/Libraries/Text/TextInput/RCTBaseTextInputView.m index 5c022a27f408bb..51afe8c3ba716f 100644 --- a/Libraries/Text/TextInput/RCTBaseTextInputView.m +++ b/Libraries/Text/TextInput/RCTBaseTextInputView.m @@ -21,6 +21,7 @@ #import #import // [macOS] #import "../RCTTextUIKit.h" // [macOS] +#import // [macOS] @implementation RCTBaseTextInputView { __weak RCTBridge *_bridge; @@ -662,7 +663,8 @@ - (BOOL)textInputShouldHandleDeleteForward:(__unused id)sender { } - (BOOL)hasValidKeyDownOrValidKeyUp:(NSString *)key { - return [self.validKeysDown containsObject:key] || [self.validKeysUp containsObject:key]; + return [RCTHandledKey key:key matchesFilter:self.validKeysDown] + || [RCTHandledKey key:key matchesFilter:self.validKeysUp]; } - (NSDragOperation)textInputDraggingEntered:(id)draggingInfo diff --git a/React/Base/RCTConvert.h b/React/Base/RCTConvert.h index 2764540b180db1..994a8cce40646f 100644 --- a/React/Base/RCTConvert.h +++ b/React/Base/RCTConvert.h @@ -20,6 +20,8 @@ #import #endif +@class RCTHandledKey; // [macOS] + /** * This class provides a collection of conversion functions for mapping * JSON objects to native types and classes. These are useful when writing @@ -147,6 +149,8 @@ typedef BOOL css_backface_visibility_t; #if TARGET_OS_OSX // [macOS + (NSString *)accessibilityRoleFromTraits:(id)json; + ++ (NSArray *)RCTHandledKeyArray:(id)json; #endif // macOS] @end diff --git a/React/Base/RCTConvert.m b/React/Base/RCTConvert.m index c5ba2de0564cf7..7d0442e30f7e75 100644 --- a/React/Base/RCTConvert.m +++ b/React/Base/RCTConvert.m @@ -12,6 +12,7 @@ #import #import "RCTDefines.h" +#import "RCTHandledKey.h" // [macOS] #import "RCTImageSource.h" #import "RCTParserUtils.h" #import "RCTUtils.h" @@ -1500,6 +1501,9 @@ + (NSString *)accessibilityRoleFromTraits:(id)json } return NSAccessibilityUnknownRole; } + +RCT_JSON_ARRAY_CONVERTER(RCTHandledKey); + #endif // macOS] @end diff --git a/React/Views/RCTHandledKey.h b/React/Views/RCTHandledKey.h new file mode 100644 index 00000000000000..f0d2562d46c9df --- /dev/null +++ b/React/Views/RCTHandledKey.h @@ -0,0 +1,40 @@ +/* + * Copyright (c) Meta Platforms, Inc. and affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +// [macOS] + +#if TARGET_OS_OSX +#import + +// This class is used for specifying key filtering e.g. for -[RCTView validKeysDown] and -[RCTView validKeysUp] +// Also see RCTViewKeyboardEvent, which is a React representation of an actual NSEvent that is dispatched to JS. +@interface RCTHandledKey : NSObject + ++ (BOOL)event:(NSEvent *)event matchesFilter:(NSArray *)filter; ++ (BOOL)key:(NSString *)key matchesFilter:(NSArray *)filter; + +- (instancetype)initWithKey:(NSString *)key; +- (BOOL)matchesEvent:(NSEvent *)event; + +@property (nonatomic, copy) NSString *key; + +// For the following modifiers, nil means we don't care about the presence of the modifier when filtering the key +// They are still expected to be only boolean when not nil. +@property (nonatomic, assign) NSNumber *altKey; +@property (nonatomic, assign) NSNumber *ctrlKey; +@property (nonatomic, assign) NSNumber *metaKey; +@property (nonatomic, assign) NSNumber *shiftKey; + +@end + +@interface RCTConvert (RCTHandledKey) + ++ (RCTHandledKey *)RCTHandledKey:(id)json; + +@end + +#endif diff --git a/React/Views/RCTHandledKey.m b/React/Views/RCTHandledKey.m new file mode 100644 index 00000000000000..aa685c3b999044 --- /dev/null +++ b/React/Views/RCTHandledKey.m @@ -0,0 +1,145 @@ +/* + * Copyright (c) Meta Platforms, Inc. and affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +// [macOS] + +#import "objc/runtime.h" +#import +#import +#import +#import +#import + +#if TARGET_OS_OSX + +@implementation RCTHandledKey + ++ (NSArray *)validModifiers { + // keep in sync with actual properties and RCTViewKeyboardEvent + return @[@"altKey", @"ctrlKey", @"metaKey", @"shiftKey"]; +} + ++ (BOOL)event:(NSEvent *)event matchesFilter:(NSArray *)filter { + for (RCTHandledKey *key in filter) { + if ([key matchesEvent:event]) { + return YES; + } + } + + return NO; +} + ++ (BOOL)key:(NSString *)key matchesFilter:(NSArray *)filter { + for (RCTHandledKey *aKey in filter) { + if ([[aKey key] isEqualToString:key]) { + return YES; + } + } + + return NO; +} + +- (instancetype)initWithKey:(NSString *)key { + if ((self = [super init])) { + self.key = key; + } + return self; +} + +- (BOOL)matchesEvent:(NSEvent *)event +{ + NSEventType type = [event type]; + if (type != NSEventTypeKeyDown && type != NSEventTypeKeyUp) { + RCTFatal(RCTErrorWithMessage([NSString stringWithFormat:@"Wrong event type (%d) sent to -[RCTHandledKey matchesEvent:]", (int)type])); + return NO; + } + + NSDictionary *body = [RCTViewKeyboardEvent bodyFromEvent:event]; + NSString *key = body[@"key"]; + if (key == nil) { + RCTFatal(RCTErrorWithMessage(@"Event body has missing value for 'key'")); + return NO; + } + + if (![key isEqualToString:self.key]) { + return NO; + } + + NSArray *modifiers = [RCTHandledKey validModifiers]; + for (NSString *modifier in modifiers) { + NSNumber *myValue = [self valueForKey:modifier]; + + if (myValue == nil) { + continue; + } + + NSNumber *eventValue = (NSNumber *)body[modifier]; + if (eventValue == nil) { + RCTFatal(RCTErrorWithMessage([NSString stringWithFormat:@"Event body has missing value for '%@'", modifier])); + return NO; + } + + if (![eventValue isKindOfClass:[NSNumber class]]) { + RCTFatal(RCTErrorWithMessage([NSString stringWithFormat:@"Event body has unexpected value of class '%@' for '%@'", + NSStringFromClass(object_getClass(eventValue)), modifier])); + return NO; + } + + if (![myValue isEqualToNumber:body[modifier]]) { + return NO; + } + } + + return YES; // keys matched; all present modifiers matched +} + +@end + +@implementation RCTConvert (RCTHandledKey) + ++ (RCTHandledKey *)RCTHandledKey:(id)json +{ + // legacy way of specifying validKeysDown and validKeysUp -- here we ignore the modifiers when comparing to the NSEvent + if ([json isKindOfClass:[NSString class]]) { + return [[RCTHandledKey alloc] initWithKey:(NSString *)json]; + } + + // modern way of specifying validKeys and validKeysUp -- here we assume missing modifiers to mean false\NO + if ([json isKindOfClass:[NSDictionary class]]) { + NSDictionary *dict = (NSDictionary *)json; + NSString *key = dict[@"key"]; + if (key == nil) { + RCTLogConvertError(dict, @"a RCTHandledKey -- must include \"key\""); + return nil; + } + + RCTHandledKey *handledKey = [[RCTHandledKey alloc] initWithKey:key]; + NSArray *modifiers = RCTHandledKey.validModifiers; + for (NSString *key in modifiers) { + id value = dict[key]; + if (value == nil) { + value = @NO; // assume NO -- instead of nil i.e. "don't care" unlike the string case above. + } + + if (![value isKindOfClass:[NSNumber class]]) { + RCTLogConvertError(value, @"a boolean"); + return nil; + } + + [handledKey setValue:@([(NSNumber *)value boolValue]) forKey:key]; + } + + return handledKey; + } + + RCTLogConvertError(json, @"a RCTHandledKey -- allowed types are string and object"); + return nil; +} + +@end + +#endif diff --git a/React/Views/RCTView.h b/React/Views/RCTView.h index 7cf6b8e0fc9ae2..7c8a3e38a7bf7c 100644 --- a/React/Views/RCTView.h +++ b/React/Views/RCTView.h @@ -23,6 +23,8 @@ extern const UIAccessibilityTraits SwitchAccessibilityTrait; @protocol RCTAutoInsetsProtocol; +@class RCTHandledKey; // [macOS] + @interface RCTView : RCTUIView // [macOS] // [macOS @@ -157,10 +159,14 @@ extern const UIAccessibilityTraits SwitchAccessibilityTrait; @property (nonatomic, copy) RCTDirectEventBlock onDrop; // Keyboarding events +// NOTE does not properly work with single line text inputs (most key downs). This is because those are +// presumably handled by the window's field editor. To make it work, we'd need to look into providing +// a custom field editor for NSTextField controls. +@property (nonatomic, assign) BOOL passthroughAllKeyEvents; @property (nonatomic, copy) RCTDirectEventBlock onKeyDown; @property (nonatomic, copy) RCTDirectEventBlock onKeyUp; -@property (nonatomic, copy) NSArray *validKeysDown; -@property (nonatomic, copy) NSArray *validKeysUp; +@property (nonatomic, copy) NSArray *validKeysDown; +@property (nonatomic, copy) NSArray *validKeysUp; // Shadow Properties @property (nonatomic, strong) NSColor *shadowColor; diff --git a/React/Views/RCTView.m b/React/Views/RCTView.m index 4046d374cef5a0..b9388aea349383 100644 --- a/React/Views/RCTView.m +++ b/React/Views/RCTView.m @@ -5,6 +5,10 @@ * LICENSE file in the root directory of this source tree. */ +// [macOS +#import "objc/runtime.h" +#import "RCTHandledKey.h" +// macOS] #import "RCTView.h" #import @@ -1681,19 +1685,52 @@ - (BOOL)performDragOperation:(id )sender #pragma mark - Keyboard Events -- (RCTViewKeyboardEvent*)keyboardEvent:(NSEvent*)event { +// This dictionary is attached to the NSEvent being handled so we can ensure we only dispatch it +// once per RCTView\nativeTag. The reason we need to track this state is that certain React native +// views such as RCTUITextView inherit from views (such as NSTextView) which may or may not +// decide to bubble the event to the next responder, and we don't want to dispatch the same +// event more than once (e.g. first from RCTUITextView, and then from it's parent RCTView). +NSMutableDictionary *GetEventDispatchStateDictionary(NSEvent *event) { + static const char *key = "RCTEventDispatchStateDictionary"; + NSMutableDictionary *dict = objc_getAssociatedObject(event, key); + if (dict == nil) { + dict = [NSMutableDictionary new]; + objc_setAssociatedObject(event, key, dict, OBJC_ASSOCIATION_RETAIN_NONATOMIC); + } + return dict; +} + +- (RCTViewKeyboardEvent*)keyboardEvent:(NSEvent*)event shouldBlock:(BOOL *)shouldBlock { BOOL keyDown = event.type == NSEventTypeKeyDown; - NSArray *validKeys = keyDown ? self.validKeysDown : self.validKeysUp; - NSString *key = [RCTViewKeyboardEvent keyFromEvent:event]; + NSArray *validKeys = keyDown ? self.validKeysDown : self.validKeysUp; - // If the view is focusable and the component didn't explicity set the validKeysDown or Up, + // If the view is focusable and the component didn't explicity set the validKeysDown or validKeysUp, // allow enter/return and spacebar key events to mimic the behavior of native controls. if (self.focusable && validKeys == nil) { - validKeys = @[@"Enter", @" "]; + validKeys = @[ + [[RCTHandledKey alloc] initWithKey:@"Enter"], + [[RCTHandledKey alloc] initWithKey:@" "] + ]; + } + + // If a view specifies a key, it will always be removed from the responder chain (i.e. "handled") + *shouldBlock = [RCTHandledKey event:event matchesFilter:validKeys]; + + // If an event isn't being removed from the queue, but was requested to "passthrough" by a view, + // we want to be sure we dispatch it only once for that view. See note for GetEventDispatchStateDictionary. + if ([self passthroughAllKeyEvents] && !*shouldBlock) { + NSNumber *tag = [self reactTag]; + NSMutableDictionary *dict = GetEventDispatchStateDictionary(event); + + if ([dict[tag] boolValue]) { + return nil; + } + + dict[tag] = @YES; } - // Only post events for keys we care about - if (![validKeys containsObject:key]) { + // Don't pass events we don't care about + if (![self passthroughAllKeyEvents] && !*shouldBlock) { return nil; } @@ -1702,10 +1739,11 @@ - (RCTViewKeyboardEvent*)keyboardEvent:(NSEvent*)event { - (BOOL)handleKeyboardEvent:(NSEvent *)event { if (event.type == NSEventTypeKeyDown ? self.onKeyDown : self.onKeyUp) { - RCTViewKeyboardEvent *keyboardEvent = [self keyboardEvent:event]; + BOOL shouldBlock = YES; + RCTViewKeyboardEvent *keyboardEvent = [self keyboardEvent:event shouldBlock:&shouldBlock]; if (keyboardEvent) { [_eventDispatcher sendEvent:keyboardEvent]; - return YES; + return shouldBlock; } } return NO; diff --git a/React/Views/RCTViewKeyboardEvent.m b/React/Views/RCTViewKeyboardEvent.m index cca78099bd0a8c..125586ee047b74 100644 --- a/React/Views/RCTViewKeyboardEvent.m +++ b/React/Views/RCTViewKeyboardEvent.m @@ -18,6 +18,7 @@ + (NSDictionary *)bodyFromEvent:(NSEvent *)event NSString *key = [self keyFromEvent:event]; NSEventModifierFlags modifierFlags = event.modifierFlags; + // when making changes here, also consider what should happen to RCTHandledKey. [macOS] return @{ @"key" : key, @"capsLockKey" : (modifierFlags & NSEventModifierFlagCapsLock) ? @YES : @NO, @@ -54,15 +55,15 @@ + (NSString *)keyFromEvent:(NSEvent *)event return @"Backspace"; } else if (code == NSDeleteFunctionKey) { return @"Delete"; - } else if (code == NSHomeFunctionKey) { - return @"Home"; - } else if (code == NSEndFunctionKey) { - return @"End"; - } else if (code == NSPageUpFunctionKey) { - return @"PageUp"; - } else if (code == NSPageDownFunctionKey) { - return @"PageDown"; - } + } else if (code == NSHomeFunctionKey) { + return @"Home"; + } else if (code == NSEndFunctionKey) { + return @"End"; + } else if (code == NSPageUpFunctionKey) { + return @"PageUp"; + } else if (code == NSPageDownFunctionKey) { + return @"PageDown"; + } return key; } diff --git a/React/Views/RCTViewManager.m b/React/Views/RCTViewManager.m index 9b7a97ebcb039b..61c79e6621ff75 100644 --- a/React/Views/RCTViewManager.m +++ b/React/Views/RCTViewManager.m @@ -511,10 +511,11 @@ - (RCTShadowView *)shadowView RCT_EXPORT_VIEW_PROPERTY(onDragEnter, RCTDirectEventBlock) RCT_EXPORT_VIEW_PROPERTY(onDragLeave, RCTDirectEventBlock) RCT_EXPORT_VIEW_PROPERTY(onDrop, RCTDirectEventBlock) +RCT_EXPORT_VIEW_PROPERTY(passthroughAllKeyEvents, BOOL) RCT_EXPORT_VIEW_PROPERTY(onKeyDown, RCTDirectEventBlock) // macOS keyboard events RCT_EXPORT_VIEW_PROPERTY(onKeyUp, RCTDirectEventBlock) // macOS keyboard events -RCT_EXPORT_VIEW_PROPERTY(validKeysDown, NSArray) -RCT_EXPORT_VIEW_PROPERTY(validKeysUp, NSArray) +RCT_EXPORT_VIEW_PROPERTY(validKeysDown, NSArray) +RCT_EXPORT_VIEW_PROPERTY(validKeysUp, NSArray) #endif // macOS] diff --git a/React/Views/ScrollView/RCTScrollView.m b/React/Views/ScrollView/RCTScrollView.m index 8ec935c262837d..195e90cfea398b 100644 --- a/React/Views/ScrollView/RCTScrollView.m +++ b/React/Views/ScrollView/RCTScrollView.m @@ -10,6 +10,7 @@ #import // [macOS] #import "RCTConvert.h" +#import "RCTHandledKey.h" // [macOS] #import "RCTLog.h" #import "RCTScrollEvent.h" #import "RCTUIManager.h" @@ -1269,11 +1270,10 @@ - (void)uiManagerWillPerformMounting:(RCTUIManager *)manager #if TARGET_OS_OSX - (RCTViewKeyboardEvent*)keyboardEvent:(NSEvent*)event { BOOL keyDown = event.type == NSEventTypeKeyDown; - NSArray *validKeys = keyDown ? self.validKeysDown : self.validKeysUp; - NSString *key = [RCTViewKeyboardEvent keyFromEvent:event]; + NSArray *validKeys = keyDown ? self.validKeysDown : self.validKeysUp; // Only post events for keys we care about - if (![validKeys containsObject:key]) { + if (![RCTHandledKey event:event matchesFilter:validKeys]) { return nil; } diff --git a/packages/rn-tester/js/examples/KeyboardEventsExample/KeyboardEventsExample.js b/packages/rn-tester/js/examples/KeyboardEventsExample/KeyboardEventsExample.js index 1ffef70b908583..40630a2028d682 100644 --- a/packages/rn-tester/js/examples/KeyboardEventsExample/KeyboardEventsExample.js +++ b/packages/rn-tester/js/examples/KeyboardEventsExample/KeyboardEventsExample.js @@ -13,88 +13,216 @@ const React = require('react'); const ReactNative = require('react-native'); import {Platform} from 'react-native'; -const {StyleSheet, Text, TextInput, View} = ReactNative; +import type {KeyEvent} from 'react-native/Libraries/Types/CoreEventTypes'; + +const {Button, ScrollView, StyleSheet, Switch, Text, TextInput, View} = + ReactNative; + +const switchStyle = { + alignItems: 'center', + padding: 10, + flexDirection: 'row', + justifyContent: 'space-between', +}; function KeyEventExample(): React.Node { const [log, setLog] = React.useState([]); - const appendLog = (line: string) => { - const limit = 12; - let newLog = log.slice(0, limit - 1); - newLog.unshift(line); - setLog(newLog); - }; + + const clearLog = React.useCallback(() => { + setLog([]); + }, [setLog]); + + const appendLog = React.useCallback( + (line: string) => { + const limit = 12; + let newLog = log.slice(0, limit - 1); + newLog.unshift(line); + setLog(newLog); + }, + [log, setLog], + ); + + const handleKeyDown = React.useCallback( + (e: KeyEvent) => { + appendLog('Key Down:' + e.nativeEvent.key); + }, + [appendLog], + ); + + const handleKeyUp = React.useCallback( + (e: KeyEvent) => { + appendLog('Key Up:' + e.nativeEvent.key); + }, + [appendLog], + ); + + const [showView, setShowView] = React.useState(true); + const toggleShowView = React.useCallback( + (value: boolean) => { + setShowView(value); + }, + [setShowView], + ); + + const [showTextInput, setShowTextInput] = React.useState(true); + const toggleShowTextInput = React.useCallback( + (value: boolean) => { + setShowTextInput(value); + }, + [setShowTextInput], + ); + + const [showTextInput2, setShowTextInput2] = React.useState(true); + const toggleShowTextInput2 = React.useCallback( + (value: boolean) => { + setShowTextInput2(value); + }, + [setShowTextInput2], + ); + + const [passthroughAllKeyEvents, setPassthroughAllKeyEvents] = + React.useState(false); + const toggleSwitch = React.useCallback( + (value: boolean) => { + setPassthroughAllKeyEvents(value); + }, + [setPassthroughAllKeyEvents], + ); return ( - - - Key events are called when a component detects a key press.To tab - between views on macOS: Enable System Preferences / Keyboard / Shortcuts - > Use keyboard navigation to move focus between controls. - - - {Platform.OS === 'macos' ? ( - <> - View - - validKeysDown: [g, Escape, Enter, ArrowLeft]{'\n'} - validKeysUp: [c, d] - - appendLog('Key Down:' + e.nativeEvent.key)} - validKeysUp={['c', 'd']} - onKeyUp={e => appendLog('Key Up:' + e.nativeEvent.key)} - /> - TextInput - - validKeysDown: [ArrowRight, ArrowDown]{'\n'} - validKeysUp: [Escape, Enter] - - appendLog('Key Down:' + e.nativeEvent.key)} - validKeysUp={['Escape', 'Enter']} - onKeyUp={e => appendLog('Key Up:' + e.nativeEvent.key)} - /> - appendLog('Key Down:' + e.nativeEvent.key)} - validKeysUp={['Escape', 'Enter']} - onKeyUp={e => appendLog('Key Up:' + e.nativeEvent.key)} - /> - - validKeysDown: []{'\n'} - validKeysUp: [] - - - + + + Key events are called when a component detects a key press.To tab + between views on macOS: Enable System Preferences / Keyboard / + Shortcuts > Use keyboard navigation to move focus between controls. + + + {Platform.OS === 'macos' ? ( + <> + + View + + + {showView ? ( + <> + + validKeysDown: [g, Escape, Enter, ArrowLeft]{'\n'} + validKeysUp: [c, d] + + + + ) : null} + + TextInput + + + {showTextInput ? ( + <> + + validKeysDown: [ArrowRight, ArrowDown, Ctrl+Enter]{'\n'} + validKeysUp: [Escape, Enter] + + + + + ) : null} + + TextInput with no handled keys + + + {showTextInput2 ? ( + <> + + validKeysDown: []{'\n'} + validKeysUp: [] + + + + + ) : null} + + ) : null} + + {'Pass through all key events'} + - - ) : null} - {'Events:\n' + log.join('\n')} + +