Skip to content

Commit 351119a

Browse files
committed
docs(modal): change to predictedBreakpoint
1 parent 3fc476a commit 351119a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/api/modal.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,13 @@ The `ionDragMove` event is emitted continuously while the user is actively dragg
228228
- `currentY` and `deltaY`: Track the absolute position and the change in distance since the last frame, useful for calculating drag direction.
229229
- `velocityY`: Measures the speed of the drag, which can be used to trigger specific animations if a user "flicks" the modal.
230230
- `progress`: A normalized value between 0 and 1 representing how far the modal is open. This is ideal for dynamically adjusting the opacity of an overlay or scaling background content as the modal moves.
231-
- `currentBreakpoint`: For sheet modals, this identifies which breakpoint the modal will snap to if released at that moment.
231+
- `predictedBreakpoint`: For sheet modals, this identifies which breakpoint the modal will snap to if released at that moment.
232232

233233
This event is essential for creating highly responsive UI updates that react instantly to the user's touch. For example, the `progress` value can be used to dynamically darken the backdrop's opacity as the modal is dragged upward.
234234

235235
#### Using `ionDragEnd`
236236

237-
The `ionDragEnd` event is emitted when the user completes the dragging gesture by releasing the modal. Like the move event, it includes the final `ModalDragEventDetail` [object](#modaldrageventdetail). This event is commonly used to finalize state changes once the modal has come to a rest. For example, you might use the `currentBreakpoint` property to determine which content to load or to update the application's routing state once the user has finished swiping the sheet to a specific height.
237+
The `ionDragEnd` event is emitted when the user completes the dragging gesture by releasing the modal. Like the move event, it includes the final `ModalDragEventDetail` [object](#modaldrageventdetail). This event is commonly used to finalize state changes once the modal has come to a rest. For example, you might use the `predictedBreakpoint` property to determine which content to load or to update the application's routing state once the user has finished swiping the sheet to a specific height.
238238

239239
<SheetDragEvents />
240240

@@ -328,7 +328,7 @@ interface ModalDragEventDetail {
328328
* This can be used to style content based on where the modal will
329329
* snap to upon release.
330330
*/
331-
currentBreakpoint?: number;
331+
predictedBreakpoint?: number;
332332
}
333333
```
334334

0 commit comments

Comments
 (0)