Skip to content

Commit 1040de2

Browse files
m-bertm-bert
committed
Share mouseButton
1 parent 0572462 commit 1040de2

7 files changed

Lines changed: 42 additions & 137 deletions

File tree

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

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
import HeaderWithBadge from '@site/src/components/HeaderWithBadge';
1010

11+
import MouseButtonProp from '../gestures/\_shared/mouse-button.mdx';
12+
13+
1114
:::info
1215
This component acts as a cross-platform replacement for React Native's [`DrawerLayoutAndroid`](http://reactnative.dev/docs/drawerlayoutandroid.html) component, written using [Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started). For detailed information on standard parameters, please refer to the [React Native documentation](http://reactnative.dev/docs/drawerlayoutandroid.html).
1316
:::
@@ -153,28 +156,7 @@ children?: ReactNode | ((openValue?: SharedValue<number>) => ReactNode);
153156

154157
Either a component rendered in the content view or a function. If `children` is a function, it receives an `openValue` parameter - [`SharedValue`](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value) that indicates the progress of the drawer's opening or closing animation. This value equals `0` when the drawer is closed and `1` when it is fully opened. The drawer component can use this value to animate its children during the opening or closing process. This function must return a [`ReactNode`](https://reactnative.dev/docs/react-node).
155158

156-
<HeaderWithBadge platforms={['android', 'web']}>
157-
### mouseButton
158-
</HeaderWithBadge>
159-
160-
<CollapsibleCode
161-
label="Show composed types definitions"
162-
expandedLabel="Hide composed types definitions"
163-
lineBounds={[0, 1]}
164-
src={`
165-
mouseButton: MouseButton | SharedValue<MouseButton>;
166-
167-
enum MouseButton {
168-
LEFT,
169-
RIGHT,
170-
MIDDLE,
171-
BUTTON_4,
172-
BUTTON_5,
173-
ALL,
174-
}
175-
`}/>
176-
177-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
159+
<MouseButtonProp />
178160

179161
<HeaderWithBadge platforms={['web']}>
180162
### enableContextMenu

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

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -252,29 +252,6 @@ enableTrackpadTwoFingerGesture?: boolean;
252252

253253
Enables two-finger gestures on supported devices, for example iPads with trackpads. If not enabled the gesture will require click + drag, with `enableTrackpadTwoFingerGesture` swiping with two fingers will also trigger the gesture.
254254

255-
<HeaderWithBadge platforms={['android', 'web']}>
256-
### mouseButton
257-
</HeaderWithBadge>
258-
259-
<CollapsibleCode
260-
label="Show composed types definitions"
261-
expandedLabel="Hide composed types definitions"
262-
lineBounds={[0, 1]}
263-
src={`
264-
mouseButton: MouseButton | SharedValue<MouseButton>;
265-
266-
enum MouseButton {
267-
LEFT,
268-
RIGHT,
269-
MIDDLE,
270-
BUTTON_4,
271-
BUTTON_5,
272-
ALL,
273-
}
274-
`}/>
275-
276-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
277-
278255
<HeaderWithBadge platforms={['web']}>
279256
### enableContextMenu
280257
</HeaderWithBadge>

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import HeaderWithBadge from '@site/src/components/HeaderWithBadge';
2+
3+
<HeaderWithBadge platforms={['android', 'web']}>
4+
### mouseButton
5+
</HeaderWithBadge>
6+
7+
<CollapsibleCode
8+
label="Show composed types definitions"
9+
expandedLabel="Hide composed types definitions"
10+
lineBounds={[0, 1]}
11+
collapsed={false}
12+
src={`
13+
mouseButton: MouseButton | SharedValue<MouseButton>;
14+
15+
enum MouseButton {
16+
LEFT,
17+
RIGHT,
18+
MIDDLE,
19+
BUTTON_4,
20+
BUTTON_5,
21+
ALL,
22+
}
23+
`}/>
24+
25+
Allows users to choose which mouse buttons to respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.

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

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import FlingGestureBasicSrc from '!!raw-loader!@site/static/examples/FlingGestur
1414

1515
import HeaderWithBadge from '@site/src/components/HeaderWithBadge';
1616

17+
import MouseButtonProp from './\_shared/mouse-button.mdx';
18+
19+
1720
<div className={webContainer}>
1821
<div className={vanishOnMobile} style={{ display: 'flex', justifyContent: 'center', maxWidth: 360 }}>
1922
<video playsInline autoPlay muted loop style={{maxWidth: 360}}>
@@ -142,29 +145,7 @@ numberOfPointers: number | SharedValue<number>;
142145

143146
Determine exact number of points required to handle the fling gesture.
144147

145-
<HeaderWithBadge platforms={['android', 'web']}>
146-
### mouseButton
147-
</HeaderWithBadge>
148-
149-
<CollapsibleCode
150-
label="Show composed types definitions"
151-
expandedLabel="Hide composed types definitions"
152-
lineBounds={[0, 1]}
153-
collapsed={false}
154-
src={`
155-
mouseButton: MouseButton | SharedValue<MouseButton>;
156-
157-
enum MouseButton {
158-
LEFT,
159-
RIGHT,
160-
MIDDLE,
161-
BUTTON_4,
162-
BUTTON_5,
163-
ALL,
164-
}
165-
`}/>
166-
167-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
148+
<MouseButtonProp />
168149

169150
<BaseGestureConfig />
170151

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

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import LongPressGestureBasicSrc from '!!raw-loader!@site/static/examples/LongPre
1414

1515
import HeaderWithBadge from '@site/src/components/HeaderWithBadge';
1616

17+
import MouseButtonProp from './\_shared/mouse-button.mdx';
18+
19+
1720
<div className={webContainer}>
1821
<div className={vanishOnMobile} style={{ display: 'flex', justifyContent: 'center', maxWidth: 360 }}>
1922
<video playsInline autoPlay muted loop style={{maxWidth: 360}}>
@@ -75,29 +78,7 @@ maxDistance: number | SharedValue<number>;
7578

7679
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.
7780

78-
<HeaderWithBadge platforms={['android', 'web']}>
79-
### mouseButton
80-
</HeaderWithBadge>
81-
82-
<CollapsibleCode
83-
label="Show composed types definitions"
84-
expandedLabel="Hide composed types definitions"
85-
lineBounds={[0, 1]}
86-
collapsed={false}
87-
src={`
88-
mouseButton: MouseButton | SharedValue<MouseButton>;
89-
90-
enum MouseButton {
91-
LEFT,
92-
RIGHT,
93-
MIDDLE,
94-
BUTTON_4,
95-
BUTTON_5,
96-
ALL,
97-
}
98-
`}/>
99-
100-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
81+
<MouseButtonProp />
10182

10283
<BaseGestureConfig />
10384

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

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import BaseContinuousGestureConfig from './\_shared/base-continuous-gesture-conf
1818
import BaseGestureCallbacks from './\_shared/base-gesture-callbacks.mdx';
1919
import BaseContinuousGestureCallbacks from './\_shared/base-continuous-gesture-callbacks.mdx';
2020
import SharedValueInfo from './\_shared/shared-value-info.md';
21+
import MouseButtonProp from './\_shared/mouse-button.mdx';
2122

2223
import CollapsibleCode from '@site/src/components/CollapsibleCode';
2324

@@ -231,29 +232,7 @@ enableTrackpadTwoFingerGesture: boolean | SharedValue<boolean>;
231232

232233
Enables two-finger gestures on supported devices, for example iPads with trackpads. If not enabled the gesture will require click + drag, with enableTrackpadTwoFingerGesture swiping with two fingers will also trigger the gesture.
233234

234-
<HeaderWithBadge platforms={['android', 'web']}>
235-
### mouseButton
236-
</HeaderWithBadge>
237-
238-
<CollapsibleCode
239-
label="Show composed types definitions"
240-
expandedLabel="Hide composed types definitions"
241-
lineBounds={[0, 1]}
242-
collapsed={false}
243-
src={`
244-
mouseButton: MouseButton | SharedValue<MouseButton>;
245-
246-
enum MouseButton {
247-
LEFT,
248-
RIGHT,
249-
MIDDLE,
250-
BUTTON_4,
251-
BUTTON_5,
252-
ALL,
253-
}
254-
`}/>
255-
256-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
235+
<MouseButtonProp />
257236

258237
<BaseContinuousGestureConfig />
259238
<BaseGestureConfig />

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

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import TapGestureBasicSrc from '!!raw-loader!@site/static/examples/TapGestureBas
1414

1515
import HeaderWithBadge from '@site/src/components/HeaderWithBadge';
1616

17+
import MouseButtonProp from './\_shared/mouse-button.mdx';
18+
1719
<div className={webContainer}>
1820
<div className={vanishOnMobile} style={{ display: 'flex', justifyContent: 'center', maxWidth: 360 }}>
1921
<video playsInline autoPlay muted loop style={{maxWidth: 360}}>
@@ -155,29 +157,7 @@ maxDistance: number | SharedValue<number>;
155157

156158
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.
157159

158-
<HeaderWithBadge platforms={['android', 'web']}>
159-
### mouseButton
160-
</HeaderWithBadge>
161-
162-
<CollapsibleCode
163-
label="Show composed types definitions"
164-
expandedLabel="Hide composed types definitions"
165-
lineBounds={[0, 1]}
166-
collapsed={false}
167-
src={`
168-
mouseButton: MouseButton | SharedValue<MouseButton>;
169-
170-
enum MouseButton {
171-
LEFT,
172-
RIGHT,
173-
MIDDLE,
174-
BUTTON_4,
175-
BUTTON_5,
176-
ALL,
177-
}
178-
`}/>
179-
180-
Allows users to choose which mouse button should handler respond to. Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`. Default value is set to `MouseButton.LEFT`.
160+
<MouseButtonProp />
181161

182162
<BaseGestureConfig />
183163

0 commit comments

Comments
 (0)