File tree Expand file tree Collapse file tree 5 files changed +28
-1
lines changed
docs-gesture-handler/docs/gestures
react-native-gesture-handler/src/handlers Expand file tree Collapse file tree 5 files changed +28
-1
lines changed Original file line number Diff line number Diff line change @@ -5,6 +5,10 @@ sidebar_label: Force touch gesture
55sidebar_position : 10
66---
77
8+ ::: warning
9+ ForceTouch gesture is depracted and will be removed in the future version of Gesture Handler.
10+ :::
11+
812import BaseEventData from './\_ shared/base-gesture-event-data.md';
913import BaseEventConfig from './\_ shared/base-gesture-config.md';
1014import BaseContinuousEventConfig from './\_ shared/base-continuous-gesture-config.md';
Original file line number Diff line number Diff line change @@ -7,6 +7,9 @@ export type FlingGestureHandlerEventPayload = {
77 absoluteY : number ;
88} ;
99
10+ /**
11+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
12+ */
1013export type ForceTouchGestureHandlerEventPayload = {
1114 x : number ;
1215 y : number ;
Original file line number Diff line number Diff line change @@ -46,8 +46,14 @@ export type TapGestureHandlerGestureEvent =
4646export type TapGestureHandlerStateChangeEvent =
4747 HandlerStateChangeEvent < TapGestureHandlerEventPayload > ;
4848
49+ /**
50+ * @deprecated ForceTouchGestureHandler is deprecated and will be removed in the future.
51+ */
4952export type ForceTouchGestureHandlerGestureEvent =
5053 GestureEvent < ForceTouchGestureHandlerEventPayload > ;
54+ /**
55+ * @deprecated ForceTouchGestureHandler is deprecated and will be removed in the future.
56+ */
5157export type ForceTouchGestureHandlerStateChangeEvent =
5258 HandlerStateChangeEvent < ForceTouchGestureHandlerEventPayload > ;
5359
@@ -84,6 +90,9 @@ export type PanGestureHandlerProperties = PanGestureHandlerProps;
8490export type PinchGestureHandlerProperties = PinchGestureHandlerProps ;
8591export type RotationGestureHandlerProperties = RotationGestureHandlerProps ;
8692export type FlingGestureHandlerProperties = FlingGestureHandlerProps ;
93+ /**
94+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
95+ */
8796export type ForceTouchGestureHandlerProperties = ForceTouchGestureHandlerProps ;
8897// Button props
8998export type RawButtonProperties = RawButtonProps ;
Original file line number Diff line number Diff line change @@ -3,6 +3,9 @@ import { ForceTouchGestureConfig } from '../ForceTouchGestureHandler';
33import type { ForceTouchGestureHandlerEventPayload } from '../GestureHandlerEventPayload' ;
44import { GestureUpdateEvent } from '../gestureHandlerCommon' ;
55
6+ /**
7+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
8+ */
69export type ForceTouchGestureChangeEventPayload = {
710 forceChange : number ;
811} ;
@@ -26,6 +29,9 @@ function changeEventCalculator(
2629 return { ...current , ...changePayload } ;
2730}
2831
32+ /**
33+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
34+ */
2935export class ForceTouchGesture extends ContinousBaseGesture <
3036 ForceTouchGestureHandlerEventPayload ,
3137 ForceTouchGestureChangeEventPayload
@@ -83,4 +89,7 @@ export class ForceTouchGesture extends ContinousBaseGesture<
8389 }
8490}
8591
92+ /**
93+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
94+ */
8695export type ForceTouchGestureType = InstanceType < typeof ForceTouchGesture > ;
Original file line number Diff line number Diff line change @@ -73,7 +73,9 @@ export const GestureObjects = {
7373 } ,
7474
7575 /**
76- * #### iOS only
76+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
77+ *
78+ * #### iOS only
7779 * A continuous gesture that recognizes force of a touch. It allows for tracking pressure of touch on some iOS devices.
7880 * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/force-touch-gesture
7981 */
You can’t perform that action at this time.
0 commit comments