Skip to content

Commit 35d2da7

Browse files
committed
Do not mention states outside dedicated page
1 parent 33a85a3 commit 35d2da7

8 files changed

Lines changed: 24 additions & 24 deletions

File tree

packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ enabled: boolean | SharedValue<boolean>;
55
```
66

77
Indicates whether the given handler should be analyzing stream of touch events or not.
8-
When set to `false` we can be sure that the handler's state will **never** become [`ACTIVE`](/docs/fundamentals/states-events#active).
9-
If the value gets updated while the handler already started recognizing a gesture, then the handler's state it will immediately change to [`FAILED`](/docs/fundamentals/states-events#failed) or [`CANCELLED`](/docs/fundamentals/states-events#cancelled) (depending on its current state).
8+
When set to `false` we can be sure that the handler will **never** activate.
9+
If the value gets updated while the handler already started recognizing a gesture, then the handler will stop processing gestures immediately.
1010
Default value is `true`.
1111

1212
### shouldCancelWhenOutside
@@ -15,7 +15,7 @@ Default value is `true`.
1515
shouldCancelWhenOutside: boolean | SharedValue<boolean>;
1616
```
1717

18-
When `true` the handler will [cancel](/docs/fundamentals/states-events#cancelled) or [fail](/docs/fundamentals/states-events#failed) recognition (depending on its current state) whenever the finger leaves the area of the connected view.
18+
When `true` the handler will stop recognition whenever the finger leaves the area of the connected view.
1919
Default value of this property is different depending on the handler type.
2020
Most handlers' `shouldCancelWhenOutside` property defaults to `false` except for the [`LongPressGesture`](/docs/gestures/use-long-press-gesture) and [`TapGesture`](/docs/gestures/use-tap-gesture) which default to `true`.
2121

@@ -42,7 +42,7 @@ type HitSlop =
4242
| Record<'height' | 'bottom', number>;
4343
```
4444

45-
This parameter enables control over what part of the connected view area can be used to [begin](/docs/fundamentals/states-events#began) recognizing the gesture.
45+
This parameter enables control over what part of the connected view area can be used to begin recognizing the gesture.
4646
When a negative number is provided the bounds of the view will reduce the area by the given number of points in each of the sides evenly.
4747

4848
Instead you can pass an object to specify how each boundary side should be reduced by providing different number of points for `left`, `right`, `top` or `bottom` sides.
@@ -69,7 +69,7 @@ cancelsTouchesInView: boolean | SharedValue<boolean>;
6969
```
7070

7171
Accepts a boolean value.
72-
When `true`, the gesture will cancel touches for native UI components (`UIButton`, `UISwitch`, etc) it's attached to when it becomes [`ACTIVE`](/docs/fundamentals/states-events#active).
72+
When `true`, the gesture will cancel touches for native UI components (`UIButton`, `UISwitch`, etc) it's attached to upon activation.
7373
Default value is `true`.
7474

7575
### runOnJS

packages/docs-gesture-handler/docs/gestures/use-fling-gesture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ import BaseGestureCallbacks from './\_shared/base-gesture-callbacks.mdx';
3131
import SharedValueInfo from './\_shared/shared-value-info.md';
3232

3333
A discrete gesture that activates when the movement is sufficiently long and fast.
34-
Gesture gets [ACTIVE](/docs/fundamentals/states-events#active) when movement is sufficiently long and it does not take too much time.
35-
When gesture gets activated it will turn into [END](/docs/fundamentals/states-events#end) state when finger is released.
34+
Gesture activates when movement is sufficiently long and it does not take too much time.
35+
When gesture gets activated it will end when finger is released.
3636
The gesture will fail to recognize if the finger is lifted before being activated.
3737

3838
<div className={appearOnMobile} style={{ display: 'flex', justifyContent: 'center' }}>

packages/docs-gesture-handler/docs/gestures/use-long-press-gesture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import BaseGestureCallbacks from './\_shared/base-gesture-callbacks.mdx';
3131
import SharedValueInfo from './\_shared/shared-value-info.md';
3232

3333
A discrete gesture that activates when the corresponding view is pressed for a sufficiently long time.
34-
This gesture's state will turn into [END](/docs/fundamentals/states-events#end) immediately after the finger is released.
34+
This gesture's state will end immediately after the finger is released.
3535
The gesture will fail to recognize a touch event if the finger is lifted before the minimum required time or if the finger is moved further than the allowable distance.
3636

3737
<div className={appearOnMobile} style={{ display: 'flex', justifyContent: 'center' }}>
@@ -102,7 +102,7 @@ Minimum time, expressed in milliseconds, that a finger must remain pressed on th
102102
maxDistance: number | SharedValue<number>;
103103
```
104104

105-
Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a long press gesture. If the finger travels further than the defined distance and the gesture hasn't yet [activated](/docs/fundamentals/states-events#active), it will fail to recognize the gesture. The default value is 10.
105+
Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a long press gesture. If the finger travels further than the defined distance and the gesture hasn't yet activated, it will fail to recognize the gesture. The default value is 10.
106106

107107
### mouseButton (Web & Android only)
108108

packages/docs-gesture-handler/docs/gestures/use-native-gesture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ Do not use `Native` gesture with components exported by React Native Gesture Han
9797
shouldActivateOnStart: boolean | SharedValue<boolean>;
9898
```
9999

100-
When `true`, underlying handler will activate unconditionally when it receives any touches in [`BEGAN`](/docs/fundamentals/states-events#began) or [`UNDETERMINED`](/docs/fundamentals/states-events#undetermined) state.
100+
When `true`, underlying handler will activate unconditionally when it receives any touches.
101101

102102
### disallowInterruption
103103

104104
```ts
105105
disallowInterruption: boolean | SharedValue<boolean>;
106106
```
107107

108-
When `true`, cancels all other gesture handlers when changes its state to [`ACTIVE`](/docs/fundamentals/states-events#active).
108+
When `true`, cancels all other gesture handlers when activates.
109109

110110
<BaseGestureConfig />
111111

packages/docs-gesture-handler/docs/gestures/use-pan-gesture.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import SharedValueInfo from './\_shared/shared-value-info.md';
3434

3535
A continuous gesture that can recognize a panning (dragging) gesture and track its movement.
3636

37-
The gesture [activates](/docs/fundamentals/states-events#active) when a finger is placed on the screen and moved some initial distance.
37+
The gesture activates when a finger is placed on the screen and moved some initial distance.
3838

3939
Configurations such as a minimum initial distance, specific vertical or horizontal pan detection and number of fingers required for activation (allowing for multifinger swipes) may be specified.
4040

@@ -128,31 +128,31 @@ If you wish to track the "center of mass" virtual pointer and account for its ch
128128
minDistance: number | SharedValue<number>;
129129
```
130130

131-
Minimum distance the finger (or multiple finger) need to travel before the gesture [activates](/docs/fundamentals/states-events#active). Expressed in points.
131+
Minimum distance the finger (or multiple finger) need to travel before the gesture activates. Expressed in points.
132132

133133
### minPointers
134134

135135
```ts
136136
minPointers: number | SharedValue<number>;
137137
```
138138

139-
A number of fingers that is required to be placed before gesture can [activate](/docs/fundamentals/states-events#active). Should be a higher or equal to 0 integer.
139+
A number of fingers that is required to be placed before gesture can activate. Should be a higher or equal to 0 integer.
140140

141141
### maxPointers
142142

143143
```ts
144144
maxPointers: number | SharedValue<number>;
145145
```
146146

147-
When the given number of fingers is placed on the screen and gesture hasn't yet [activated](/docs/fundamentals/states-events#active) it will fail recognizing the gesture. Should be a higher or equal to 0 integer.
147+
When the given number of fingers is placed on the screen and gesture hasn't yet activated it will fail recognizing the gesture. Should be a higher or equal to 0 integer.
148148

149149
### activateAfterLongPress
150150

151151
```ts
152152
activateAfterLongPress: number | SharedValue<number>;
153153
```
154154

155-
Duration in milliseconds of the `LongPress` gesture before `Pan` is allowed to [activate](/docs/fundamentals/states-events#active). If the finger is moved during that period, the gesture will [fail](/docs/fundamentals/states-events#failed). Should be a higher or equal to 0 integer. Default value is 0, meaning no `LongPress` is required to [activate](/docs/fundamentals/states-events#active) the `Pan`.
155+
Duration in milliseconds of the `LongPress` gesture before `Pan` is allowed to activate. If the finger is moved during that period, the gesture will fail. Should be a higher or equal to 0 integer. Default value is 0, meaning no `LongPress` is required to activate the `Pan`.
156156

157157
### activeOffsetX
158158

packages/docs-gesture-handler/docs/gestures/use-pinch-gesture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import BaseContinuousGestureCallbacks from './\_shared/base-continuous-gesture-c
3333
import SharedValueInfo from './\_shared/shared-value-info.md';
3434

3535
A continuous gesture that recognizes pinch gesture. It allows for tracking the distance between two fingers and use that information to scale or zoom your content.
36-
The gesture [activates](/docs/fundamentals/states-events#active) when fingers are placed on the screen and change their position.
36+
The gesture activates when fingers are placed on the screen and change their position.
3737
Gesture callback can be used for continuous tracking of the pinch gesture. It provides information about velocity, anchor (focal) point of gesture and scale.
3838

3939
The distance between the fingers is reported as a scale factor. At the beginning of the gesture, the scale factor is 1.0. As the distance between the two fingers increases, the scale factor increases proportionally.

packages/docs-gesture-handler/docs/gestures/use-rotation-gesture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import SharedValueInfo from './\_shared/shared-value-info.md';
3434

3535
A continuous gesture that can recognize a rotation gesture and track its movement.
3636

37-
The gesture [activates](/docs/fundamentals/states-events#active) when fingers are placed on the screen and change position in a proper way.
37+
The gesture activates when fingers are placed on the screen and change position in a proper way.
3838

3939
Gesture callback can be used for continuous tracking of the rotation gesture. It provides information about the gesture such as the amount rotated, the focal point of the rotation (anchor), and its instantaneous velocity.
4040

packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The pointers involved in these gestures must not move significantly from their i
3737
The required number of taps and allowed distance from initial position may be configured.
3838
For example, you might configure tap gesture recognizers to detect single taps, double taps, or triple taps.
3939

40-
In order for a gesture to [activate](/docs/fundamentals/states-events#active), specified gesture requirements such as minPointers, numberOfTaps, maxDistance, maxDuration, and maxDelay (explained below) must be met. Immediately after the gesture [activates](/docs/fundamentals/states-events#active), it will [end](/docs/fundamentals/states-events#end).
40+
In order for a gesture to activate, specified gesture requirements such as minPointers, numberOfTaps, maxDistance, maxDuration, and maxDelay (explained below) must be met. Immediately after the gesture activates, it will end.
4141

4242
<div className={appearOnMobile} style={{ display: 'flex', justifyContent: 'center' }}>
4343
<video playsInline autoPlay muted loop style={{maxWidth: 360}}>
@@ -97,7 +97,7 @@ const styles = StyleSheet.create({
9797
minPointers: number | SharedValue<number>;
9898
```
9999

100-
Minimum number of pointers (fingers) required to be placed before the gesture [activates](/docs/fundamentals/states-events#active). Should be a positive integer. The default value is 1.
100+
Minimum number of pointers (fingers) required to be placed before the gesture activates. Should be a positive integer. The default value is 1.
101101

102102
### maxDuration
103103

@@ -121,31 +121,31 @@ Maximum time, expressed in milliseconds, that can pass before the next tap — i
121121
numberOfTaps: number | SharedValue<number>;
122122
```
123123

124-
Number of tap gestures required to [activate](/docs/fundamentals/states-events#active) the gesture. The default value is 1.
124+
Number of tap gestures required to activate the gesture. The default value is 1.
125125

126126
### maxDeltaX
127127

128128
```ts
129129
maxDeltaX: number | SharedValue<number>;
130130
```
131131

132-
Maximum distance, expressed in points, that defines how far the finger is allowed to travel along the X axis during a tap gesture. If the finger travels further than the defined distance along the X axis and the gesture hasn't yet [activated](/docs/fundamentals/states-events#active), it will fail to recognize the gesture.
132+
Maximum distance, expressed in points, that defines how far the finger is allowed to travel along the X axis during a tap gesture. If the finger travels further than the defined distance along the X axis and the gesture hasn't yet activated, it will fail to recognize the gesture.
133133

134134
### maxDeltaY
135135

136136
```ts
137137
maxDeltaY: number | SharedValue<number>;
138138
```
139139

140-
Maximum distance, expressed in points, that defines how far the finger is allowed to travel along the Y axis during a tap gesture. If the finger travels further than the defined distance along the Y axis and the gesture hasn't yet [activated](/docs/fundamentals/states-events#active), it will fail to recognize the gesture.
140+
Maximum distance, expressed in points, that defines how far the finger is allowed to travel along the Y axis during a tap gesture. If the finger travels further than the defined distance along the Y axis and the gesture hasn't yet activated, it will fail to recognize the gesture.
141141

142142
### maxDistance
143143

144144
```ts
145145
maxDistance: number | SharedValue<number>;
146146
```
147147

148-
Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a tap gesture. If the finger travels further than the defined distance and the gesture hasn't yet [activated](/docs/fundamentals/states-events#active), it will fail to recognize the gesture.
148+
Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a tap gesture. If the finger travels further than the defined distance and the gesture hasn't yet activated, it will fail to recognize the gesture.
149149

150150
### mouseButton (Web & Android only)
151151

0 commit comments

Comments
 (0)