feat: add caretHeight and caretYoffset to TextInput component

Author: OlimpiaZurek

Libraries/Components/TextInput/TextInput.d.ts

@@ -573,6 +573,18 @@ export interface TextInputProps
    */
   caretHidden?: boolean | undefined;
 
+  /**
+   * Allows to adjust caret height.
+   * The default value is 0, which means the height of the caret will be calculated automatically
+   */
+  caretHeight?: number | undefined;
+
+  /**
+   * Allows to adjust caret postiion relative to the Y axis
+   * The default value is 0.
+   */
+  caretYOffset?: number | undefined;
+
   /**
    * If true, context menu is hidden. The default value is false.
    */

Libraries/Components/TextInput/TextInput.flow.js

@@ -557,6 +557,18 @@ export type Props = $ReadOnly<{|
    */
   caretHidden?: ?boolean,
 
+  /**
+   * Allows to adjust caret height.
+   * The default value is 0, which means the height of the caret will be calculated automatically
+   */
+
+  caretYOffset?: ?number,
+  /**
+   * Allows to adjust caret postiion relative to the Y axis
+   * The default value is 0.
+   */
+  caretYHeight?: ?number,
+
   /*
    * If `true`, contextMenuHidden is hidden. The default value is `false`.
    */

Libraries/Components/TextInput/TextInput.js

@@ -368,6 +368,17 @@ type IOSProps = $ReadOnly<{|
    * @platform ios
    */
   smartInsertDelete?: ?boolean,
+  /**
+   * Allows to adjust caret height.
+   * The default value is 0, which means the height of the caret will be calculated automatically
+   */
+  caretYOffset?: ?number,
+
+  /**
+   * Allows to adjust caret postiion relative to the Y axis
+   * The default value is 0.
+   */
+  caretHeight?: ?number,
 |}>;
 
 type AndroidProps = $ReadOnly<{|
@@ -1459,6 +1470,8 @@ function InternalTextInput(props: Props): React.Node {
         selection={selection}
         style={style}
         text={text}
+        caretYOffset={props.caretYOffset}
+        caretHeight={props.caretHeight}
       />
     );
   } else if (Platform.OS === 'android') {

Libraries/Text/TextInput/Multiline/RCTUITextView.h

@@ -34,6 +34,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, assign) UITextFieldViewMode clearButtonMode;
 
 @property (nonatomic, assign) BOOL caretHidden;
+@property (nonatomic, assign) CGFloat caretYOffset;
+@property (nonatomic, assign) CGFloat caretHeight;
 
 @property (nonatomic, strong, nullable) NSString *inputAccessoryViewID;
 

Libraries/Text/TextInput/Multiline/RCTUITextView.m

@@ -13,6 +13,41 @@
 #import <React/RCTBackedTextInputDelegateAdapter.h>
 #import <React/RCTTextAttributes.h>
 
+//the UITextSelectionRect subclass needs to be created because the original version is not writable
+@interface CustomTextSelectionRect : UITextSelectionRect
+
+@property (nonatomic) CGRect _rect;
+@property (nonatomic) NSWritingDirection _writingDirection;
+@property (nonatomic) BOOL _containsStart; // Returns YES if the rect contains the start of the selection.
+@property (nonatomic) BOOL _containsEnd; // Returns YES if the rect contains the end of the selection.
+@property (nonatomic) BOOL _isVertical; // Returns YES if the rect is for vertically oriented text.
+
+@end
+
+@implementation CustomTextSelectionRect
+
+- (CGRect)rect {
+    return __rect;
+}
+
+- (NSWritingDirection)writingDirection {
+    return __writingDirection;
+}
+
+- (BOOL)containsStart {
+    return __containsStart;
+}
+
+- (BOOL)containsEnd {
+    return __containsEnd;
+}
+
+- (BOOL)isVertical {
+    return __isVertical;
+}
+
+@end
+
 @implementation RCTUITextView {
   UILabel *_placeholderView;
   UITextView *_detachedTextView;
@@ -294,11 +329,43 @@ - (void)_updatePlaceholder
 
 - (CGRect)caretRectForPosition:(UITextPosition *)position
 {
+  CGRect originalRect = [super caretRectForPosition:position];
+
   if (_caretHidden) {
     return CGRectZero;
   }
 
-  return [super caretRectForPosition:position];
+  if(_caretYOffset != 0) {
+    originalRect.origin.y += _caretYOffset;
+  }
+
+    if(_caretHeight != 0) {
+    originalRect.size.height = _caretHeight;
+  }
+    return originalRect;
+}
+
+- (NSArray *)selectionRectsForRange:(UITextRange *)range {
+  NSArray *superRects = [super selectionRectsForRange:range];
+  if(_caretYOffset != 0 && _caretHeight != 0) {
+    NSMutableArray *customTextSelectionRects = [NSMutableArray array];
+
+    for (UITextSelectionRect *rect in superRects) {
+        CustomTextSelectionRect *customTextRect = [[CustomTextSelectionRect alloc] init];
+
+        customTextRect._rect = CGRectMake(rect.rect.origin.x, rect.rect.origin.y + _caretYOffset, rect.rect.size.width, _caretHeight);
+        customTextRect._writingDirection = rect.writingDirection;
+        customTextRect._containsStart = rect.containsStart;
+        customTextRect._containsEnd = rect.containsEnd;
+        customTextRect._isVertical = rect.isVertical;
+        [customTextSelectionRects addObject:customTextRect];
+    }
+
+    return customTextSelectionRects;
+
+  }
+  return superRects;
+
 }
 
 #pragma mark - Utility Methods

Libraries/Text/TextInput/RCTBackedTextInputViewProtocol.h

@@ -27,6 +27,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, assign) BOOL contextMenuHidden;
 @property (nonatomic, assign, getter=isEditable) BOOL editable;
 @property (nonatomic, assign) BOOL caretHidden;
+@property (nonatomic, assign) CGFloat caretYOffset;
+@property (nonatomic, assign) CGFloat caretHeight;
 @property (nonatomic, assign) BOOL enablesReturnKeyAutomatically;
 @property (nonatomic, assign) UITextFieldViewMode clearButtonMode;
 @property (nonatomic, getter=isScrollEnabled) BOOL scrollEnabled;

Libraries/Text/TextInput/RCTBaseTextInputViewManager.m

@@ -44,6 +44,8 @@ @implementation RCTBaseTextInputViewManager {
 RCT_REMAP_VIEW_PROPERTY(selectionColor, backedTextInputView.tintColor, UIColor)
 RCT_REMAP_VIEW_PROPERTY(spellCheck, backedTextInputView.spellCheckingType, UITextSpellCheckingType)
 RCT_REMAP_VIEW_PROPERTY(caretHidden, backedTextInputView.caretHidden, BOOL)
+RCT_REMAP_VIEW_PROPERTY(caretYOffset, backedTextInputView.caretYOffset, CGFloat)
+RCT_REMAP_VIEW_PROPERTY(caretHeight, backedTextInputView.caretHeight, CGFloat)
 RCT_REMAP_VIEW_PROPERTY(clearButtonMode, backedTextInputView.clearButtonMode, UITextFieldViewMode)
 RCT_REMAP_VIEW_PROPERTY(scrollEnabled, backedTextInputView.scrollEnabled, BOOL)
 RCT_REMAP_VIEW_PROPERTY(secureTextEntry, backedTextInputView.secureTextEntry, BOOL)

React/Fabric/Mounting/ComponentViews/TextInput/RCTTextInputComponentView.mm

@@ -153,6 +153,14 @@ - (void)updateProps:(Props::Shared const &)props oldProps:(Props::Shared const &
     _backedTextInputView.caretHidden = newTextInputProps.traits.caretHidden;
   }
 
+  if(newTextInputProps.traits.caretYOffset != oldTextInputProps.traits.caretYOffset) {
+    _backedTextInputView.caretYOffset = newTextInputProps.traits.caretYOffset;
+  }
+
+  if(newTextInputProps.traits.caretHeight != oldTextInputProps.traits.caretHeight) {
+    _backedTextInputView.caretHeight = newTextInputProps.traits.caretHeight;
+  }
+
   if (newTextInputProps.traits.clearButtonMode != oldTextInputProps.traits.clearButtonMode) {
     _backedTextInputView.clearButtonMode =
         RCTUITextFieldViewModeFromTextInputAccessoryVisibilityMode(newTextInputProps.traits.clearButtonMode);

React/Fabric/Mounting/ComponentViews/TextInput/RCTTextInputUtils.mm

@@ -38,6 +38,8 @@ void RCTCopyBackedTextInput(
   toTextInput.keyboardAppearance = fromTextInput.keyboardAppearance;
   toTextInput.spellCheckingType = fromTextInput.spellCheckingType;
   toTextInput.caretHidden = fromTextInput.caretHidden;
+  toTextInput.caretYOffset = fromTextInput.caretYOffset;
+  toTextInput.caretHeight = toTextInput.caretHeight;
   toTextInput.clearButtonMode = fromTextInput.clearButtonMode;
   toTextInput.scrollEnabled = fromTextInput.scrollEnabled;
   toTextInput.secureTextEntry = fromTextInput.secureTextEntry;

ReactCommon/react/renderer/components/textinput/iostextinput/primitives.h

@@ -156,6 +156,19 @@ class TextInputTraits final {
    */
   bool caretHidden{false};
 
+  /*
+   * iOS-only (inherently iOS-specific)
+   * Default value: 0 with a default font.
+   */
+
+  int caretHeight{0};
+
+  /*
+   * iOS-only (inherently iOS-specific)
+   * Default value: 0 means that the caret offset will have the default value
+   */
+  int caretYOffset{0};
+
   /*
    * Controls the visibility of a `Clean` button.
    * iOS-only (implemented only on iOS for now)