Skip to content

Commit 37c2d97

Browse files
bump t-rex-ui
1 parent ee266bb commit 37c2d97

115 files changed

Lines changed: 13400 additions & 2938 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ sidebar_label: Buttons
77
import useBaseUrl from '@docusaurus/useBaseUrl';
88
import GifGallery from '@site/components/GifGallery';
99

10-
import HeaderWithBadges from '@site/src/components/HeaderWithBadges';
11-
1210
<GifGallery>
1311
<img src={useBaseUrl('gifs/samplebutton.gif')} width="280" />
1412
</GifGallery>
@@ -39,19 +37,19 @@ exclusive?: boolean;
3937

4038
Defines if more than one button could be pressed simultaneously. By default set to `true`.
4139

42-
<HeaderWithBadges platforms={['android']}>
40+
<Badges platforms={['android']}>
4341
### rippleColor
44-
</HeaderWithBadges>
42+
</Badges>
4543

4644
```ts
4745
rippleColor?: number | ColorValue | null;
4846
```
4947

5048
Defines [color](https://reactnative.dev/docs/colors) of native [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation.
5149

52-
<HeaderWithBadges platforms={['android']}>
50+
<Badges platforms={['android']}>
5351
### rippleRadius
54-
</HeaderWithBadges>
52+
</Badges>
5553

5654

5755
```ts
@@ -60,29 +58,29 @@ rippleRadius?: number | null;
6058

6159
Defines radius of native [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation.
6260

63-
<HeaderWithBadges platforms={['android']}>
61+
<Badges platforms={['android']}>
6462
### borderless
65-
</HeaderWithBadges>
63+
</Badges>
6664

6765
```ts
6866
borderless?: boolean;
6967
```
7068

7169
If set to `false`, [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation will render only within view bounds.
7270

73-
<HeaderWithBadges platforms={['android']}>
71+
<Badges platforms={['android']}>
7472
### foreground
75-
</HeaderWithBadges>
73+
</Badges>
7674

7775
```ts
7876
foreground?: boolean;
7977
```
8078

8179
Defines whether the [ripple](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable) animation should be drawn on the foreground of the view.
8280

83-
<HeaderWithBadges platforms={['android']}>
81+
<Badges platforms={['android']}>
8482
### touchSoundDisabled
85-
</HeaderWithBadges>
83+
</Badges>
8684

8785
```ts
8886
touchSoundDisabled?: boolean;
@@ -140,9 +138,9 @@ underlayColor?: string;
140138

141139
Background color that will be dimmed when button is in active state.
142140

143-
<HeaderWithBadges platforms={['iOS']}>
141+
<Badges platforms={['ios']}>
144142
### activeOpacity
145-
</HeaderWithBadges>
143+
</Badges>
146144

147145
```ts
148146
activeOpacity?: number;
@@ -154,9 +152,9 @@ Opacity applied to the underlay when button is in active state.
154152

155153
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:
156154

157-
<HeaderWithBadges platforms={['iOS']}>
155+
<Badges platforms={['ios']}>
158156
### activeOpacity
159-
</HeaderWithBadges>
157+
</Badges>
160158

161159
```ts
162160
activeOpacity?: number;

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

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ sidebar_label: Pressable
77
import useBaseUrl from '@docusaurus/useBaseUrl';
88
import GifGallery from '@site/components/GifGallery';
99

10-
import HeaderWithBadges from '@site/src/components/HeaderWithBadges';
11-
1210
:::info
1311
This component is a drop-in replacement for the `Pressable` component.
1412
:::
@@ -89,39 +87,39 @@ cancelable?: null | boolean;
8987

9088
Whether a press gesture can be interrupted by a parent gesture such as a scroll event. Defaults to `true`.
9189

92-
<HeaderWithBadges platforms={['android', 'web']}>
90+
<Badges platforms={['android', 'web']}>
9391
### onHoverIn
94-
</HeaderWithBadges>
92+
</Badges>
9593

9694
```ts
9795
onHoverIn?: null | ((event: PressableEvent) => void);
9896
```
9997

10098
Called when pointer is hovering over the element.
10199

102-
<HeaderWithBadges platforms={['android', 'web']}>
100+
<Badges platforms={['android', 'web']}>
103101
### onHoverOut
104-
</HeaderWithBadges>
102+
</Badges>
105103

106104
```ts
107105
onHoverOut?: null | ((event: PressableEvent) => void);
108106
```
109107

110108
Called when pointer stops hovering over the element.
111109

112-
<HeaderWithBadges platforms={['web']}>
110+
<Badges platforms={['web']}>
113111
### delayHoverIn
114-
</HeaderWithBadges>
112+
</Badges>
115113

116114
```ts
117115
delayHoverIn?: number | null;
118116
```
119117

120118
Duration to wait after hover in before calling `onHoverIn`.
121119

122-
<HeaderWithBadges platforms={['web']}>
120+
<Badges platforms={['web']}>
123121
### delayHoverOut
124-
</HeaderWithBadges>
122+
</Badges>
125123

126124
```ts
127125
delayHoverOut?: number | null;
@@ -145,9 +143,9 @@ disabled?: null | boolean;
145143

146144
Whether the `Pressable` behavior is disabled.
147145

148-
<HeaderWithBadges platforms={['android', 'iOS']}>
146+
<Badges platforms={['android', 'ios']}>
149147
### hitSlop
150-
</HeaderWithBadges>
148+
</Badges>
151149

152150
```ts
153151
hitSlop?: null | Insets | number;
@@ -157,9 +155,9 @@ Additional distance outside of the view in which a press is detected and [`onPre
157155

158156
The `Insets` type is essentially the same as [`Rect`](https://reactnative.dev/docs/rect).
159157

160-
<HeaderWithBadges platforms={['android', 'iOS']}>
158+
<Badges platforms={['android', 'ios']}>
161159
### pressRetentionOffset
162-
</HeaderWithBadges>
160+
</Badges>
163161

164162
```ts
165163
pressRetentionOffset?: null | Insets | number;
@@ -170,19 +168,19 @@ press before [`onPressOut`](#onpressout) is triggered.
170168

171169
The `Insets` type is essentially the same as [`Rect`](https://reactnative.dev/docs/rect).
172170

173-
<HeaderWithBadges platforms={['android']}>
171+
<Badges platforms={['android']}>
174172
### android_disableSound
175-
</HeaderWithBadges>
173+
</Badges>
176174

177175
```ts
178176
android_disableSound?: null | boolean;
179177
```
180178

181179
If `true`, doesn't play system sound on touch.
182180

183-
<HeaderWithBadges platforms={['android']}>
181+
<Badges platforms={['android']}>
184182
### android_ripple
185-
</HeaderWithBadges>
183+
</Badges>
186184

187185
```ts
188186
android_ripple?: null | PressableAndroidRippleConfig;

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ sidebar_label: Reanimated Drawer Layout
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

9-
import HeaderWithBadges from '@site/src/components/HeaderWithBadges';
10-
119
import MouseButtonProp from '../gestures/\_shared/mouse-button.mdx';
1210

1311
:::info
@@ -221,9 +219,9 @@ export enum DrawerState {
221219

222220
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.
223221

224-
<HeaderWithBadges platforms={['iOS']}>
222+
<Badges platforms={['ios']}>
225223
### enableTrackpadTwoFingerGesture
226-
</HeaderWithBadges>
224+
</Badges>
227225

228226
```ts
229227
enableTrackpadTwoFingerGesture?: boolean;
@@ -242,29 +240,29 @@ Either a component rendered in the content view or a function. If `children` is
242240

243241
<MouseButtonProp />
244242

245-
<HeaderWithBadges platforms={['web']}>
243+
<Badges platforms={['web']}>
246244
### enableContextMenu
247-
</HeaderWithBadges>
245+
</Badges>
248246

249247
```ts
250248
enableContextMenu: boolean;
251249
```
252250

253251
Specifies whether context menu should be enabled after clicking on underlying view with right mouse button. Default value is set to `false` if [`MouseButton.RIGHT`](#mousebutton-web--android-only) is specified.
254252

255-
<HeaderWithBadges platforms={['web']}>
253+
<Badges platforms={['web']}>
256254
### userSelect
257-
</HeaderWithBadges>
255+
</Badges>
258256

259257
```ts
260258
userSelect: 'none' | 'auto' | 'text';
261259
```
262260

263261
This parameter allows to specify which `userSelect` property should be applied to underlying view. Default value is set to `"none"`.
264262

265-
<HeaderWithBadges platforms={['web']}>
263+
<Badges platforms={['web']}>
266264
### activeCursor
267-
</HeaderWithBadges>
265+
</Badges>
268266

269267
```ts
270268
activeCursor: ActiveCursor;

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ sidebar_label: Reanimated Swipeable
77
import useBaseUrl from '@docusaurus/useBaseUrl';
88
import GifGallery from '@site/components/GifGallery'
99

10-
import HeaderWithBadges from '@site/src/components/HeaderWithBadges';
11-
1210
:::info
1311
This component is a drop-in replacement for the `Swipeable` component, rewritten using [Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started).
1412
:::
@@ -242,9 +240,9 @@ blocksExternalGesture?: AnyGesture | AnyGesture[];
242240

243241
Gestures that `Swipeable` will prevent from activating (see [gesture composition section](/docs/fundamentals/gesture-composition#simultaneouswith)).
244242

245-
<HeaderWithBadges platforms={['iOS']}>
243+
<Badges platforms={['ios']}>
246244
### enableTrackpadTwoFingerGesture
247-
</HeaderWithBadges>
245+
</Badges>
248246

249247
```ts
250248
enableTrackpadTwoFingerGesture?: boolean;

packages/docs-gesture-handler/docs/fundamentals/animated-interactions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Integration with Animated
55
sidebar_position: 9
66
---
77

8-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
8+
99

1010
Using hook API allows for smooth integration with the [Animated API](https://reactnative.dev/docs/animated) by allowing for passing an `Animated.event` as the argument to the [`onUpdate`](/docs/fundamentals/callbacks-events#onupdate) callback. The event mapping of `Animated.event` depends on the [`useNativeDriver`](https://reactnative.dev/docs/animated#using-the-native-driver) property.
1111

packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 6
66
---
77

88
import { GestureEventFlowChart, TouchEventFlowChart } from '@site/src/examples/CallbacksFlowCharts'
9-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
9+
1010

1111
At any given time, each handler instance has an assigned [state](/docs/under-the-hood/state) that can change when new touch events occur or can be forced to change by the touch system under certain circumstances. You can hook into state transitions using specific [gesture callbacks](#callbacks).
1212

packages/docs-gesture-handler/docs/fundamentals/gesture-composition.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Gesture composition & interactions
55
sidebar_position: 5
66
---
77

8-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
8+
99

1010
import Competing from '!!raw-loader!.//\_examples/hooks/Competing';
1111
import Simultaneous from '!!raw-loader!.//\_examples/hooks/Simultaneous';

packages/docs-gesture-handler/docs/fundamentals/gesture-detector.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ sidebar_label: Gesture detectors
55
sidebar_position: 4
66
---
77

8-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
9-
import HeaderWithBadges from '@site/src/components/HeaderWithBadges';
8+
109

1110
## Gesture Detector
1211

@@ -190,29 +189,29 @@ gesture: SingleGesture | ComposedGesture;
190189

191190
A gesture object containing the configuration and callbacks. Can be any of the base gestures or any [`ComposedGesture`](/docs/fundamentals/gesture-composition).
192191

193-
<HeaderWithBadges platforms={['web']}>
192+
<Badges platforms={['web']}>
194193
### userSelect
195-
</HeaderWithBadges>
194+
</Badges>
196195

197196
```ts
198197
userSelect: 'none' | 'auto' | 'text';
199198
```
200199

201200
This parameter allows to specify which `userSelect` property should be applied to underlying view. Default value is set to `"none"`.
202201

203-
<HeaderWithBadges platforms={['web']}>
202+
<Badges platforms={['web']}>
204203
### touchAction
205-
</HeaderWithBadges>
204+
</Badges>
206205

207206
```ts
208207
touchAction: TouchAction;
209208
```
210209

211210
This parameter allows to specify which `touchAction` property should be applied to 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"`.
212211

213-
<HeaderWithBadges platforms={['web']}>
212+
<Badges platforms={['web']}>
214213
### enableContextMenu
215-
</HeaderWithBadges>
214+
</Badges>
216215

217216
```ts
218217
enableContextMenu: boolean;

packages/docs-gesture-handler/docs/fundamentals/reanimated-interactions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Integration with Reanimated
55
sidebar_position: 8
66
---
77

8-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
8+
99

1010
[`GestureDetector`](/docs/fundamentals/gesture-detectors) will decide whether to use [Reanimated](https://docs.swmansion.com/react-native-reanimated/) to process provided gestures based on their configuration. If any of the callbacks is a [worklet](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary/#worklet) and Reanimated is not explicitly [turned off](#disabling-reanimated), tools provided by the Reanimated will be utilized, bringing the ability to handle gestures synchronously on the main thread.
1111

packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: State manager
55
sidebar_position: 7
66
---
77

8-
import CollapsibleCode from '@site/src/components/CollapsibleCode';
8+
99

1010
RNGH3 allows to manually control [gestures lifecycle](/docs/under-the-hood/state) by using [`GestureStateManager`](#gesturestatemanager).
1111

0 commit comments

Comments
 (0)