File tree Expand file tree Collapse file tree 4 files changed +19
-6
lines changed Expand file tree Collapse file tree 4 files changed +19
-6
lines changed Original file line number Diff line number Diff line change @@ -83,6 +83,18 @@ Specify whether the sheet background is dimmed. Set to `false` to allow interact
83
83
| - | - | - | - |
84
84
| ` boolean ` | ` true ` | ✅ | ✅ |
85
85
86
+ ### ` initialIndex `
87
+
88
+ Initially present the sheet, after loading, at a given size index.
89
+
90
+ | Type | Default | 🍎 | 🤖 |
91
+ | - | - | - | - |
92
+ | ` number ` | ` -1 ` | ✅ | ✅ |
93
+
94
+ :::info
95
+ This property is only used during the initial load.
96
+ :::
97
+
86
98
### ` dimmedIndex `
87
99
88
100
The size index that the sheet should start to dim the background.
@@ -185,6 +197,10 @@ const App = () => {
185
197
}
186
198
```
187
199
200
+ ### ` onLoad `
201
+
202
+ This is called when the sheet is ready to present. Use this event to [ ` present ` ] ( reference/methods#present ) the sheet during mount.
203
+
188
204
### ` onPresent `
189
205
190
206
Comes with [ ` SizeInfo ` ] ( /reference/types#sizeinfo ) .
Original file line number Diff line number Diff line change @@ -131,12 +131,9 @@ export interface TrueSheetProps extends ViewProps {
131
131
dimmed ?: boolean
132
132
133
133
/**
134
- * Sets the initial size index to present during mount.
135
- * Omitting this prop will initially hide the sheet.
136
- *
137
- * @note This prop does not change the sheet's size on the fly.
138
- * Use the `present` method instead.
134
+ * Initially present the sheet, after loading, at a given size index.
139
135
*
136
+ * @note This property is only used during the initial load.
140
137
* @default -1
141
138
*/
142
139
initialIndex ?: number
@@ -217,7 +214,7 @@ export interface TrueSheetProps extends ViewProps {
217
214
FooterComponent ?: ComponentType < unknown > | ReactElement
218
215
219
216
/**
220
- * Called when the sheet is ready to present.
217
+ * This is called when the sheet is ready to present.
221
218
*/
222
219
onLoad ?: ( ) => void
223
220
You can’t perform that action at this time.
0 commit comments