Skip to content

Commit 1c4d8ec

Browse files
docs: update presentModal examples to new inferred-typing API
Co-Authored-By: rdlabo <sakakibara@rdlabo.jp>
1 parent 4e91075 commit 1c4d8ec

3 files changed

Lines changed: 51 additions & 11 deletions

File tree

‎package-lock.json‎

Lines changed: 34 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎projects/kit/README.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ export class MyPage {
127127
readonly #overlay = inject(KitOverlayController);
128128

129129
async openDetail(): Promise<void> {
130-
const result = await this.#overlay.presentModal<{ id: number }>(DetailPage, { item });
131-
// result is the data passed to modal.dismiss()
130+
const result = await this.#overlay.presentModal(DetailPage, { item });
131+
// result type is inferred from `declare static modalReturn` on DetailPage
132132
}
133133

134134
async confirm(): Promise<void> {
@@ -149,11 +149,12 @@ export class MyPage {
149149
**API**
150150

151151
```typescript
152-
presentModal<O>(
153-
component: ModalOptions['component'],
154-
componentProps?: ModalOptions['componentProps'],
155-
options?: KitModalPresentOptions, // Omit<ModalOptions, 'component'|'componentProps'> + watchKeyboard?
156-
): Promise<O | undefined>
152+
presentModal<C extends ModalOptions['component']>(
153+
component: C,
154+
...args: ModalPresentArgs<C>, // props inferred from input() fields; options?: KitModalPresentOptions
155+
): Promise<ModalReturnOf<C> | undefined>
156+
// Props inferred from the component's input() fields (required/optional).
157+
// Return type inferred from `declare static modalReturn: T` on the component (void if absent).
157158

158159
presentPopover<O>(
159160
component: PopoverOptions['component'],
@@ -182,9 +183,14 @@ alertConfirm(options: {
182183
**Best practice — the modal launcher pattern.** Never call `modalController.create(...)` inline in a component. Instead, each modal/popover page exports a typed launcher next to itself and every call site goes through `KitOverlayController`:
183184

184185
```typescript
185-
// detail.page.ts
186-
export const launchDetailPage = (overlay: KitOverlayController, props: DetailProps): Promise<DetailResult | undefined> =>
187-
overlay.presentModal<DetailResult>(DetailPage, props, { backdropDismiss: false });
186+
// detail.page.ts — component declares its return type:
187+
export class DetailPage {
188+
declare static modalReturn: DetailResult;
189+
readonly item = input.required<Item>();
190+
}
191+
192+
export const launchDetailPage = (overlay: KitOverlayController, props: { item: Item }): Promise<DetailResult | undefined> =>
193+
overlay.presentModal(DetailPage, props, { backdropDismiss: false });
188194
```
189195

190196
This centralizes presentation options, keeps component props and dismiss data type-safe, and makes every modal discoverable. A well-disciplined app has **zero** inline `controller.create()` calls.

‎projects/kit/src/lib/overlay/kit-overlay.controller.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ const watchModalKeyboard = async (modal: HTMLIonModalElement): Promise<PluginLis
167167
* constructor(private readonly overlay: KitOverlayController) {}
168168
*
169169
* async edit(): Promise<void> {
170-
* const result = await this.overlay.presentModal<EditResult>(EditPage, { id: 1 });
170+
* const result = await this.overlay.presentModal(EditPage, { id: 1 });
171171
* if (result) {
172172
* await this.overlay.presentToast({ message: 'Saved' });
173173
* }

0 commit comments

Comments
 (0)