Skip to content

Add preventClipping prop #17

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

Closed
wants to merge 4 commits into from
Closed
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
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ public class ReactEditText extends AppCompatEditText
private static final KeyListener sKeyListener = QwertyKeyListener.getInstanceForFullKeyboard();
private @Nullable EventDispatcher mEventDispatcher;

private final ReactEditTextClickDetector clickDetector = new ReactEditTextClickDetector(this);

public ReactEditText(Context context) {
super(context);
setFocusableInTouchMode(false);
Expand Down Expand Up @@ -207,6 +209,13 @@ public boolean onTouchEvent(MotionEvent ev) {
// Disallow parent views to intercept touch events, until we can detect if we should be
// capturing these touches or not.
this.getParent().requestDisallowInterceptTouchEvent(true);
clickDetector.handleDown(ev);
break;
case MotionEvent.ACTION_UP:
clickDetector.handleUp(ev);
break;
case MotionEvent.ACTION_CANCEL:
clickDetector.cancelPress();
break;
case MotionEvent.ACTION_MOVE:
if (mDetectScrollMovement) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package com.facebook.react.views.textinput;

import android.os.Build;
import android.view.MotionEvent;
import android.view.View;

import androidx.annotation.Nullable;

class ReactEditTextClickDetector {

private static final long MAX_CLICK_DURATION_MS = 250L;
private static final int MAX_CLICK_DISTANCE_DP = 12;

private final ReactEditText reactEditText;
private final float screenDensity;

@Nullable
private TimestampedMotionEvent currentDownEvent;

public ReactEditTextClickDetector(final ReactEditText reactEditText) {
this.reactEditText = reactEditText;
screenDensity = reactEditText.getResources().getDisplayMetrics().density;
}

void handleDown(final MotionEvent downEvent) {
currentDownEvent = new TimestampedMotionEvent(downEvent);
}

void cancelPress() {
currentDownEvent = null;
}

void handleUp(final MotionEvent upEvent) {
if (currentDownEvent == null) {
return;
}

final TimestampedMotionEvent downEvent = currentDownEvent;
currentDownEvent = null;

// for now, if we're not forcing showing the keyboard on clicks, we don't care if it was a
// click. we also early return if the view is not enabled.
if (!(forceShowKeyboardOnClicks() && reactEditText.isEnabled())) {
return;
}

// make sure the press event was close enough in time
final long now = System.currentTimeMillis();
final long timeDelta = now - downEvent.timestamp;
if (timeDelta > MAX_CLICK_DURATION_MS) {
return;
}

// make sure the press event was close enough in distance
final float oldX = downEvent.motionEvent.getRawX();
final float oldY = downEvent.motionEvent.getRawY();
final float newX = upEvent.getRawX();
final float newY = upEvent.getRawY();

// distance = sqrt((x2 − x1)^2 + (y2 − y1)^2)
final double distancePx = Math.sqrt(
Math.pow((newX - oldX), 2) + Math.pow((newY - oldY), 2)
);

double distanceDp = distancePx / screenDensity;
if (distanceDp > MAX_CLICK_DISTANCE_DP) {
return;
}

reactEditText.showSoftKeyboard();
}

/**
* There is a bug on Android 7/8/9 where clicking the view while it is already
* focused does not show the keyboard. On those API levels, we force showing
* the keyboard when we detect a click.
*/
private static boolean forceShowKeyboardOnClicks() {
return Build.VERSION.SDK_INT <= Build.VERSION_CODES.P;
}

private static class TimestampedMotionEvent {

final long timestamp;
final MotionEvent motionEvent;

TimestampedMotionEvent(final long timestamp, final MotionEvent motionEvent) {
this.timestamp = timestamp;
this.motionEvent = motionEvent;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ public void onLayoutChange(
private int mLayoutDirection;
private float mBackfaceOpacity = 1.f;
private String mBackfaceVisibility = "visible";
private boolean mPreventClipping = false;

public ReactViewGroup(Context context) {
super(context);
Expand Down Expand Up @@ -279,6 +280,19 @@ public void setBorderStyle(@Nullable String style) {
getOrCreateReactViewBackground().setBorderStyle(style);
}

public void setPreventClipping(boolean preventClipping) {
mPreventClipping = preventClipping;

// TODO(apkumar)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this TODO blocking for this merge? Or more like something you plan to fix at some future date?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's blocking merge, it still works as expected as far as I can tell. It would just be a bit more accurate.

//
// It would be nice to trigger the LayoutChangeListener at this point.
}

public boolean getPreventClipping() {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Random q -- should we also look to add this to iOS as well?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can tell it's not an issue to provide props that don't exist. We could look into it.

return mPreventClipping;
}


@Override
public void setRemoveClippedSubviews(boolean removeClippedSubviews) {
if (removeClippedSubviews == mRemoveClippedSubviews) {
Expand Down Expand Up @@ -366,16 +380,22 @@ private void updateSubviewClipStatus(Rect clippingRect, int idx, int clippedSoFa
// it won't be size and located properly.
Animation animation = child.getAnimation();
boolean isAnimating = animation != null && !animation.hasEnded();
if (!intersects && child.getParent() != null && !isAnimating) {

boolean preventClipping = false;
if (child instanceof ReactViewGroup) {
preventClipping = ((ReactViewGroup)child).getPreventClipping();
}

if (!intersects && child.getParent() != null && !isAnimating && !preventClipping) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you confirm that scrolling down for a bit and then scrolling back up doesn't break things? In our testing it wasn't sufficient to only insert things here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh yeah oops i forgot to add that

// We can try saving on invalidate call here as the view that we remove is out of visible area
// therefore invalidation is not necessary.
super.removeViewsInLayout(idx - clippedSoFar, 1);
needUpdateClippingRecursive = true;
} else if (intersects && child.getParent() == null) {
} else if ((intersects || preventClipping) && child.getParent() == null) {
super.addViewInLayout(child, idx - clippedSoFar, sDefaultLayoutParam, true);
invalidate();
needUpdateClippingRecursive = true;
} else if (intersects) {
} else if (intersects || preventClipping) {
// If there is any intersection we need to inform the child to update its clipping rect
needUpdateClippingRecursive = true;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ public class ReactViewManager extends ReactClippingViewManager<ReactViewGroup> {
private static final int CMD_SET_PRESSED = 2;
private static final String HOTSPOT_UPDATE_KEY = "hotspotUpdate";

@ReactProp(name = "preventClipping")
public void setPreventClipping(ReactViewGroup view, boolean preventClipping) {
view.setPreventClipping(preventClipping);
}

@ReactProp(name = "accessible")
public void setAccessible(ReactViewGroup view, boolean accessible) {
view.setFocusable(accessible);
Expand Down