Skip to content

Commit 68afd5e

Browse files
committed
update arg name
1 parent dfc6c56 commit 68afd5e

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ export type OverlayParams<T> = {
4545
};
4646
```
4747

48-
| Name | Type | Description |
49-
| :-------------------- | :------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50-
| `renderUnderlayLeft` | `RenderUnderlay` | Component to be rendered underneath row on left swipe. |
51-
| `renderUnderlayRight` | `RenderUnderlay` | Component to be rendered underneath row on right swipe. |
52-
| `snapPointsLeft` | `number[]` | Pixel values left-swipe snaps to (eg. `[100, 300]`) |
53-
| `snapPointsRight` | `number[]` | Pixel values right-swipe snaps to (eg. `[100, 300]`) |
54-
| `renderOverlay` | `RenderOverlay` | Component to be rendered on top. Use if you need access to programmatic open/close methods. May altenatively pass children to SwipeableItem. |
55-
| `onChange` | `(params: { open: OpenDirection, snapPoint: number }) => void` | Called when row is opened or closed. |
56-
| `swipeEnabled` | `boolean` | Enable/disable swipe. Defaults to `true`. |
57-
| `activationThreshold` | `number` | Distance finger must travel before swipe engages. Defaults to 20. |
58-
| `swipeDamping` | `number` | How much swipe velocity determines snap position. A smaller number means swipe velocity will have a larger effect and row will swipe open more easily. Defaults to `10`. |
48+
| Name | Type | Description |
49+
| :-------------------- | :---------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50+
| `renderUnderlayLeft` | `RenderUnderlay` | Component to be rendered underneath row on left swipe. |
51+
| `renderUnderlayRight` | `RenderUnderlay` | Component to be rendered underneath row on right swipe. |
52+
| `snapPointsLeft` | `number[]` | Pixel values left-swipe snaps to (eg. `[100, 300]`) |
53+
| `snapPointsRight` | `number[]` | Pixel values right-swipe snaps to (eg. `[100, 300]`) |
54+
| `renderOverlay` | `RenderOverlay` | Component to be rendered on top. Use if you need access to programmatic open/close methods. May altenatively pass children to SwipeableItem. |
55+
| `onChange` | `(params: { openDirection: OpenDirection, snapPoint: number }) => void` | Called when row is opened or closed. |
56+
| `swipeEnabled` | `boolean` | Enable/disable swipe. Defaults to `true`. |
57+
| `activationThreshold` | `number` | Distance finger must travel before swipe engages. Defaults to 20. |
58+
| `swipeDamping` | `number` | How much swipe velocity determines snap position. A smaller number means swipe velocity will have a larger effect and row will swipe open more easily. Defaults to `10`. |
5959

6060
### Hooks
6161

src/index.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,10 @@ type Props<T> = {
7070
renderOverlay?: RenderOverlay<T>;
7171
renderUnderlayLeft?: RenderUnderlay<T>;
7272
renderUnderlayRight?: RenderUnderlay<T>;
73-
onChange?: (params: { open: OpenDirection; snapPoint: number }) => void;
73+
onChange?: (params: {
74+
openDirection: OpenDirection;
75+
snapPoint: number;
76+
}) => void;
7477
overSwipe?: number;
7578
animationConfig?: Partial<WithSpringConfig>;
7679
activationThreshold?: number;
@@ -267,7 +270,7 @@ function SwipeableItem<T>(
267270
openDirection !== OpenDirection.NONE ||
268271
_openDirection !== OpenDirection.NONE;
269272
if (didChange) {
270-
onChange({ open: _openDirection, snapPoint });
273+
onChange({ openDirection: _openDirection, snapPoint });
271274
}
272275
}
273276

0 commit comments

Comments
 (0)