Skip to content

Swipe close threshold #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 7, 2025
Merged

Swipe close threshold #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
180c0b9
Add swipeCloseThreshold
notiv-nt Aug 27, 2025
c3c1a85
Update README.md
notiv-nt Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,20 +132,21 @@ For Nuxt 3, just wrap component in `<ClientOnly>`

### Prop Definitions

| Prop | Type | Default | Description |
| ------------------- | ------------------------- | ---------------- | ---------------------------------------------- |
| duration | Number | 250 | Animation duration in milliseconds |
| snapPoints | Array<number\|string> | [instinctHeight] | Custom snapping positions |
| initialSnapPoint | Number | minHeight | Initial snap point index |
| blocking | Boolean | true | Block interactions with underlying content |
| canSwipeClose | Boolean | true | Enable swipe-to-close gesture |
| canBackdropClose | Boolean | true | Allow closing by tapping backdrop |
| expandOnContentDrag | Boolean | true | Enable expanding by dragging content |
| teleprtTo | String \| RendererElement | body | Teleport to a specific element |
| teleportDefer | Boolean | false | Defer teleporting until opened (Vue 3.5+ only) |
| headerClass | String | '' | Set header element class |
| contentClass | String | '' | Set content element class |
| footerClass | String | '' | Set footer element class |
| Prop | Type | Default | Description |
| ------------------- | ------------------------- | ---------------- | ------------------------------------------------------------------------- |
| duration | Number | 250 | Animation duration in milliseconds |
| snapPoints | Array<number\|string> | [instinctHeight] | Custom snapping positions |
| initialSnapPoint | Number | minHeight | Initial snap point index |
| blocking | Boolean | true | Block interactions with underlying content |
| canSwipeClose | Boolean | true | Enable swipe-to-close gesture |
| swipeCloseThreshold | Number\|String | "50%" | The amount of translation (in px or %) after which the element will close |
| canBackdropClose | Boolean | true | Allow closing by tapping backdrop |
| expandOnContentDrag | Boolean | true | Enable expanding by dragging content |
| teleportTo | String \| RendererElement | body | Teleport to a specific element |
| teleportDefer | Boolean | false | Defer teleporting until opened (Vue 3.5+ only) |
| headerClass | String | '' | Set header element class |
| contentClass | String | '' | Set content element class |
| footerClass | String | '' | Set footer element class |

## Exposed methods

Expand All @@ -160,7 +161,7 @@ Assuming there is `const bottomSheet = ref()`
## Events

| Event | Description | Payload |
| -------------- | -------------------------------------- | ----------------------- |
| --------------- | -------------------------------------- | ----------------------- |
| opened | Emitted when sheet finishes opening | - |
| opening-started | Emitted when sheet starts opening | - |
| closed | Emitted when sheet finishes closing | - |
Expand Down
26 changes: 21 additions & 5 deletions packages/vue-spring-bottom-sheet/src/BottomSheet.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,11 +316,27 @@ const handlePan = async (_: PointerEvent, info: PanInfo) => {
}

const handlePanEnd = () => {
translateY.value = props.canSwipeClose
? [0, height.value].reduce((prev, curr) =>
Math.abs(curr - translateY.value) < Math.abs(prev - translateY.value) ? curr : prev,
)
: 0
if (props.canSwipeClose) {
let threshold = height.value / 2

if (props.swipeCloseThreshold && typeof props.swipeCloseThreshold === 'number') {
threshold = props.swipeCloseThreshold
}

if (
props.swipeCloseThreshold &&
typeof props.swipeCloseThreshold === 'string' &&
props.swipeCloseThreshold.includes('%')
) {
threshold = height.value * (Number(props.swipeCloseThreshold.replace('%', '')) / 100)
}

if (translateY.value > threshold) {
translateY.value = height.value
}
} else {
translateY.value = 0
}

controls = animate(translateYValue, translateY.value, {
duration: props.duration / 1000,
Expand Down
1 change: 1 addition & 0 deletions packages/vue-spring-bottom-sheet/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export interface BottomSheetProps {
initialSnapPoint?: number
blocking?: boolean
canSwipeClose?: boolean
swipeCloseThreshold?: string | number
canBackdropClose?: boolean
expandOnContentDrag?: boolean
modelValue?: boolean
Expand Down