Skip to content

Commit edcd60c

Browse files
authored
[Docs] Add platform circles (#4370)
## Description This PR bumps `t-rex-ui` to add newly implemented platform circles. ## Test plan Read docs 🤓
1 parent 91ef2c8 commit edcd60c

14 files changed

Lines changed: 1308 additions & 1441 deletions

‎packages/docs-gesture-handler/docs/components/buttons.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ exclusive?: boolean;
4343
Defines whether pressing this button prevents other buttons exported by Gesture Handler from being pressed. By default set to `true`.
4444

4545
<Badges platforms={['android']}>
46-
### rippleColor
46+
### rippleColor [A]
4747
</Badges>
4848

4949
```ts
@@ -53,7 +53,7 @@ rippleColor?: number | ColorValue | null;
5353
Defines [color](https://reactnative.dev/docs/colors) of native [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation.
5454

5555
<Badges platforms={['android']}>
56-
### rippleRadius
56+
### rippleRadius [A]
5757
</Badges>
5858

5959

@@ -64,7 +64,7 @@ rippleRadius?: number | null;
6464
Defines radius of native [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation.
6565

6666
<Badges platforms={['android']}>
67-
### borderless
67+
### borderless [A]
6868
</Badges>
6969

7070
```ts
@@ -74,7 +74,7 @@ borderless?: boolean;
7474
If set to `false`, [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation will render only within view bounds.
7575

7676
<Badges platforms={['android']}>
77-
### foreground
77+
### foreground [A]
7878
</Badges>
7979

8080
```ts
@@ -84,7 +84,7 @@ foreground?: boolean;
8484
Defines whether the [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation should be drawn on the foreground of the view.
8585

8686
<Badges platforms={['android']}>
87-
### touchSoundDisabled
87+
### touchSoundDisabled [A]
8888
</Badges>
8989

9090
```ts
@@ -144,7 +144,7 @@ underlayColor?: string;
144144
Background color that will be dimmed when the button is in an active state.
145145

146146
<Badges platforms={['ios']}>
147-
### activeOpacity
147+
### activeOpacity [I]
148148
</Badges>
149149

150150
```ts
@@ -158,7 +158,7 @@ Opacity applied to the underlay when the button is in an active state.
158158
This type of button component should be used with simple icon-only or text-only buttons. The interaction will be different depending on platform: on Android a borderless ripple will be rendered (it means that the ripple will animate into a circle that can span outside of the view bounds), whereas on iOS the button will be dimmed (similar to how `TouchableOpacity` works). In addition to the props of [`BaseButton`](#basebutton), it accepts the following:
159159

160160
<Badges platforms={['ios']}>
161-
### activeOpacity
161+
### activeOpacity [I]
162162
</Badges>
163163

164164
```ts

‎packages/docs-gesture-handler/docs/components/pressable.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ cancelable?: null | boolean;
8989
Whether a press gesture can be interrupted by a parent gesture such as a scroll event. Defaults to `true`.
9090

9191
<Badges platforms={['android', 'web']}>
92-
### onHoverIn
92+
### onHoverIn [A][W]
9393
</Badges>
9494

9595
```ts
@@ -99,7 +99,7 @@ onHoverIn?: null | ((event: PressableEvent) => void);
9999
Called when pointer is hovering over the element.
100100

101101
<Badges platforms={['android', 'web']}>
102-
### onHoverOut
102+
### onHoverOut [A][W]
103103
</Badges>
104104

105105
```ts
@@ -109,7 +109,7 @@ onHoverOut?: null | ((event: PressableEvent) => void);
109109
Called when pointer stops hovering over the element.
110110

111111
<Badges platforms={['web']}>
112-
### delayHoverIn
112+
### delayHoverIn [W]
113113
</Badges>
114114

115115
```ts
@@ -119,7 +119,7 @@ delayHoverIn?: number | null;
119119
Duration to wait after hover in before calling `onHoverIn`.
120120

121121
<Badges platforms={['web']}>
122-
### delayHoverOut
122+
### delayHoverOut [W]
123123
</Badges>
124124

125125
```ts
@@ -145,7 +145,7 @@ disabled?: null | boolean;
145145
Whether the `Pressable` behavior is disabled.
146146

147147
<Badges platforms={['android', 'ios']}>
148-
### hitSlop
148+
### hitSlop [A][I]
149149
</Badges>
150150

151151
```ts
@@ -157,7 +157,7 @@ Additional distance outside of the view in which a press is detected and [`onPre
157157
The `Insets` type is essentially the same as [`Rect`](https://reactnative.dev/docs/rect).
158158

159159
<Badges platforms={['android', 'ios']}>
160-
### pressRetentionOffset
160+
### pressRetentionOffset [A][I]
161161
</Badges>
162162

163163
```ts
@@ -170,7 +170,7 @@ press before [`onPressOut`](#onpressout) is triggered.
170170
The `Insets` type is essentially the same as [`Rect`](https://reactnative.dev/docs/rect).
171171

172172
<Badges platforms={['android']}>
173-
### android_disableSound
173+
### android_disableSound [A]
174174
</Badges>
175175

176176
```ts
@@ -180,7 +180,7 @@ android_disableSound?: null | boolean;
180180
If `true`, doesn't play system sound on touch.
181181

182182
<Badges platforms={['android']}>
183-
### android_ripple
183+
### android_ripple [A]
184184
</Badges>
185185

186186
```ts
@@ -192,7 +192,7 @@ Enables the Android [ripple](https://developer.android.com/reference/android/gra
192192
Accepts values of type [`RippleConfig`](https://reactnative.dev/docs/pressable#rippleconfig).
193193

194194
<Badges platforms={['android']}>
195-
### needsOffscreenAlphaCompositing
195+
### needsOffscreenAlphaCompositing [A]
196196
</Badges>
197197

198198
```ts

‎packages/docs-gesture-handler/docs/components/reanimated-drawer-layout.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ export enum DrawerState {
229229
A function is called when the status of the drawer changes, taking `newState` to represent the drawer's interaction state and `drawerWillShow`, which is `true` when the drawer starts animating towards the open position and `false` otherwise.
230230

231231
<Badges platforms={['ios', 'web']}>
232-
### enableTrackpadTwoFingerGesture
232+
### enableTrackpadTwoFingerGesture [I][W]
233233
</Badges>
234234

235235
```ts
@@ -250,7 +250,7 @@ Either a component rendered in the content view or a function. If `children` is
250250
<MouseButtonProp />
251251

252252
<Badges platforms={['web']}>
253-
### enableContextMenu
253+
### enableContextMenu [W]
254254
</Badges>
255255

256256
```ts
@@ -260,7 +260,7 @@ enableContextMenu: boolean;
260260
Specifies whether the context menu should be enabled after clicking on the underlying view with the right mouse button. Default value is set to `false` if [`MouseButton.RIGHT`](#mousebutton-web--android-only) is specified.
261261

262262
<Badges platforms={['web']}>
263-
### userSelect
263+
### userSelect [W]
264264
</Badges>
265265

266266
```ts
@@ -270,7 +270,7 @@ userSelect: 'none' | 'auto' | 'text';
270270
This parameter allows specifying which `userSelect` property should be applied to the underlying view. Default value is set to `"none"`.
271271

272272
<Badges platforms={['web']}>
273-
### activeCursor
273+
### activeCursor [W]
274274
</Badges>
275275

276276
```ts

‎packages/docs-gesture-handler/docs/components/reanimated_swipeable.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ block?: AnyGesture | AnyGesture[];
242242
Gestures that `Swipeable` will prevent from activating (see [`block`](/docs/composition/block)).
243243

244244
<Badges platforms={['ios', 'web']}>
245-
### enableTrackpadTwoFingerGesture
245+
### enableTrackpadTwoFingerGesture [I][W]
246246
</Badges>
247247

248248
```ts

‎packages/docs-gesture-handler/docs/components/touchable.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ exclusive?: boolean;
357357
Defines whether pressing this button prevents other buttons exported by Gesture Handler from being pressed. By default set to `true`.
358358

359359
<Badges platforms={['android']}>
360-
### touchSoundDisabled
360+
### touchSoundDisabled [A]
361361
</Badges>
362362

363363
```ts
@@ -466,7 +466,7 @@ Defines the delay, in milliseconds, after which the [`onLongPress`](#onlongpress
466466

467467

468468
<Badges platforms={['android']}>
469-
### androidRipple
469+
### androidRipple [A]
470470
</Badges>
471471

472472
<CollapsibleCode
@@ -487,7 +487,7 @@ type PressableAndroidRippleConfig = {
487487
Configuration for the ripple effect on Android. If not provided, the ripple effect will be disabled. If `{}` is provided, the ripple effect will be enabled with default configuration.
488488

489489
<Badges platforms={['android', 'ios']}>
490-
### cancelOnLeave
490+
### cancelOnLeave [A][I]
491491
</Badges>
492492

493493
```ts
@@ -497,7 +497,7 @@ cancelOnLeave?: boolean;
497497
Whether the touch should be canceled when the pointer leaves the component. By default set to `true`. On web this prop doesn't have any effect and behaves as if `true` was set.
498498

499499
<Badges platforms={['android']}>
500-
### needsOffscreenAlphaCompositing
500+
### needsOffscreenAlphaCompositing [A]
501501
</Badges>
502502

503503
```ts

‎packages/docs-gesture-handler/docs/core-components/gesture-detector.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ gesture: SingleGesture | ComposedGesture;
188188
A gesture object containing the configuration and callbacks. Can be any of the base gestures or any [`ComposedGesture`](/docs/composition/overview).
189189

190190
<Badges platforms={['web']}>
191-
### userSelect
191+
### userSelect [W]
192192
</Badges>
193193

194194
```ts
@@ -198,7 +198,7 @@ userSelect: 'none' | 'auto' | 'text';
198198
This parameter allows specifying which `userSelect` property should be applied to the underlying view. Default value is set to `"none"`.
199199

200200
<Badges platforms={['web']}>
201-
### touchAction
201+
### touchAction [W]
202202
</Badges>
203203

204204
```ts
@@ -208,7 +208,7 @@ touchAction: TouchAction;
208208
This parameter allows specifying which `touchAction` property should be applied to the underlying view. Supports all CSS [touch-action](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/touch-action) values. Default value is set to `"none"`.
209209

210210
<Badges platforms={['web']}>
211-
### enableContextMenu
211+
### enableContextMenu [W]
212212
</Badges>
213213

214214
```ts

‎packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ testID: string;
6868
Sets a `testID` property for gesture object, allowing for querying for it in tests.
6969

7070
<Badges platforms={['ios']}>
71-
### cancelsTouchesInView
71+
### cancelsTouchesInView [I]
7272
</Badges>
7373

7474
```ts
@@ -138,7 +138,7 @@ useAnimated: boolean;
138138
Setting this property to `true` ensures that the [Animated API](/docs/fundamentals/animated-interactions) functions correctly when `useNativeDriver` is set to `false`. The default value is set to `false`.
139139

140140
<Badges platforms={['web']}>
141-
### activeCursor
141+
### activeCursor [W]
142142
</Badges>
143143

144144
```ts
@@ -148,7 +148,7 @@ activeCursor: ActiveCursor | SharedValue<ActiveCursor>;
148148
This parameter allows specifying which cursor should be used when the gesture activates. Supports all [CSS cursor values](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/cursor#keyword) (e.g. `"grab"`, `"zoom-in"`). Default value is set to `"auto"`.
149149

150150
<Badges platforms={['ios', 'android']}>
151-
### cancelsJSResponder
151+
### cancelsJSResponder [A][I]
152152
</Badges>
153153

154154
```ts

‎packages/docs-gesture-handler/docs/gestures/_shared/mouse-button.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

33
<Badges platforms={['android', 'web']}>
4-
### mouseButton
4+
### mouseButton [A][W]
55
</Badges>
66

77
<CollapsibleCode

‎packages/docs-gesture-handler/docs/gestures/use-hover-gesture.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ const styles = StyleSheet.create({
8181
<SharedValueInfo />
8282

8383
<Badges platforms={['ios']}>
84-
### effect
84+
### effect [I]
8585
</Badges>
8686

8787
<CollapsibleCode

‎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,7 +97,7 @@ export default function App() {
9797
<SharedValueInfo />
9898

9999
<Badges platforms={['android']}>
100-
### shouldActivateOnStart
100+
### shouldActivateOnStart [A]
101101
</Badges>
102102

103103

@@ -124,7 +124,7 @@ yieldsToContinuousGestures: boolean | SharedValue<boolean>;
124124
Composes with [`disallowInterruption`](#disallowinterruption). When both are `true`, this handler still cancels discrete gestures (`Tap`, `LongPress`, `Fling`) on activation but allows continuous gestures (`Pan`, `Pinch`, `Rotation`, `Native`, `Manual`, `Hover`) to interrupt it. No-op when `disallowInterruption` is `false`. Defaults to `false`.
125125

126126
<Badges platforms={['android', 'ios']}>
127-
### delaysChildPressedState
127+
### delaysChildPressedState [A][I]
128128
</Badges>
129129

130130
```ts

0 commit comments

Comments
 (0)