Skip to content

Commit 82f093d

Browse files
authored
docs(modal): clarify content requirement for sheet modal (#3570)
1 parent 10536f4 commit 82f093d

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/api/modal.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,10 @@ import CardExample from '@site/static/usage/v8/modal/card/basic/index.md';
119119

120120
### Sheet Modal
121121

122+
:::info
123+
[Content](./content) must be used inside of the sheet modal otherwise your modal content will not be scrollable.
124+
:::
125+
122126
Developers can create a sheet modal effect similar to the drawer components available in maps applications. To create a sheet modal, developers need to set the `breakpoints` and `initialBreakpoint` properties on `ion-modal`.
123127

124128
The `breakpoints` property accepts an array which states each breakpoint that the sheet can snap to when swiped. A `breakpoints` property of `[0, 0.5, 1]` would indicate that the sheet can be swiped to show 0% of the modal, 50% of the modal, and 100% of the modal. When the modal is swiped to 0%, the modal will be automatically dismissed. Note that the modal cannot be dismissed on swipe if no `0` breakpoint is included, but it can still be dismissed by pressing `Esc` or the hardware back button.

versioned_docs/version-v7/api/modal.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ import CardExample from '@site/static/usage/v7/modal/card/basic/index.md';
123123

124124
### Sheet Modal
125125

126+
:::info
127+
[Content](./content) must be used inside of the sheet modal otherwise your modal content will not be scrollable.
128+
:::
129+
126130
Developers can create a sheet modal effect similar to the drawer components available in maps applications. To create a sheet modal, developers need to set the `breakpoints` and `initialBreakpoint` properties on `ion-modal`.
127131

128132
The `breakpoints` property accepts an array which states each breakpoint that the sheet can snap to when swiped. A `breakpoints` property of `[0, 0.5, 1]` would indicate that the sheet can be swiped to show 0% of the modal, 50% of the modal, and 100% of the modal. When the modal is swiped to 0%, the modal will be automatically dismissed. Note that the modal cannot be dismissed on swipe if no `0` breakpoint is included, but it can still be dismissed by pressing `Esc` or the hardware back button.

0 commit comments

Comments
 (0)