From b0d53ca73619585671d8cf4dc24e47f826495a0a Mon Sep 17 00:00:00 2001 From: William Martin Date: Fri, 2 Apr 2021 13:00:36 -0400 Subject: [PATCH] docs(action-sheet, alert, popover, toast): update usage to show onDidDismiss (#23133) --- core/src/components/action-sheet/readme.md | 16 ++++++++++++-- .../components/action-sheet/usage/angular.md | 3 +++ .../action-sheet/usage/javascript.md | 5 ++++- .../components/action-sheet/usage/stencil.md | 3 +++ core/src/components/action-sheet/usage/vue.md | 5 ++++- core/src/components/alert/readme.md | 16 ++++++++++++-- core/src/components/alert/usage/angular.md | 3 +++ core/src/components/alert/usage/javascript.md | 5 ++++- core/src/components/alert/usage/stencil.md | 3 +++ core/src/components/alert/usage/vue.md | 5 ++++- core/src/components/popover/readme.md | 21 +++++++++++++++---- core/src/components/popover/usage/angular.md | 5 ++++- .../components/popover/usage/javascript.md | 6 +++++- core/src/components/popover/usage/stencil.md | 5 ++++- core/src/components/popover/usage/vue.md | 5 ++++- core/src/components/toast/readme.md | 20 ++++++++++++++---- core/src/components/toast/usage/angular.md | 5 ++++- core/src/components/toast/usage/javascript.md | 5 ++++- core/src/components/toast/usage/stencil.md | 5 ++++- core/src/components/toast/usage/vue.md | 5 ++++- 20 files changed, 122 insertions(+), 24 deletions(-) diff --git a/core/src/components/action-sheet/readme.md b/core/src/components/action-sheet/readme.md index d43895b277..2b97c72fd4 100644 --- a/core/src/components/action-sheet/readme.md +++ b/core/src/components/action-sheet/readme.md @@ -94,6 +94,9 @@ export class ActionSheetExample { }] }); await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } @@ -147,7 +150,10 @@ async function presentActionSheet() { } }]; document.body.appendChild(actionSheet); - return actionSheet.present(); + await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` @@ -316,6 +322,9 @@ export class ActionSheetExample { }] }); await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { @@ -389,7 +398,10 @@ export default defineComponent({ }, ], }); - return actionSheet.present(); + await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, }); diff --git a/core/src/components/action-sheet/usage/angular.md b/core/src/components/action-sheet/usage/angular.md index 472efbddfc..62bda29787 100644 --- a/core/src/components/action-sheet/usage/angular.md +++ b/core/src/components/action-sheet/usage/angular.md @@ -50,6 +50,9 @@ export class ActionSheetExample { }] }); await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } diff --git a/core/src/components/action-sheet/usage/javascript.md b/core/src/components/action-sheet/usage/javascript.md index 1084c93aae..7cc06603a4 100644 --- a/core/src/components/action-sheet/usage/javascript.md +++ b/core/src/components/action-sheet/usage/javascript.md @@ -38,6 +38,9 @@ async function presentActionSheet() { } }]; document.body.appendChild(actionSheet); - return actionSheet.present(); + await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` diff --git a/core/src/components/action-sheet/usage/stencil.md b/core/src/components/action-sheet/usage/stencil.md index 489d22b498..286ea21dff 100644 --- a/core/src/components/action-sheet/usage/stencil.md +++ b/core/src/components/action-sheet/usage/stencil.md @@ -47,6 +47,9 @@ export class ActionSheetExample { }] }); await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { diff --git a/core/src/components/action-sheet/usage/vue.md b/core/src/components/action-sheet/usage/vue.md index 8e9d4169e5..c089b5de34 100644 --- a/core/src/components/action-sheet/usage/vue.md +++ b/core/src/components/action-sheet/usage/vue.md @@ -56,7 +56,10 @@ export default defineComponent({ }, ], }); - return actionSheet.present(); + await actionSheet.present(); + + const { role } = await actionSheet.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, }); diff --git a/core/src/components/alert/readme.md b/core/src/components/alert/readme.md index 6a1eba65e8..3486898a8c 100644 --- a/core/src/components/alert/readme.md +++ b/core/src/components/alert/readme.md @@ -72,6 +72,9 @@ export class AlertExample { }); await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } async presentAlertMultipleButtons() { @@ -381,7 +384,10 @@ function presentAlert() { alert.buttons = ['OK']; document.body.appendChild(alert); - return alert.present(); + await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } function presentAlertMultipleButtons() { @@ -1031,6 +1037,9 @@ export class AlertExample { }); await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } async presentAlertMultipleButtons() { @@ -1364,7 +1373,10 @@ export default defineComponent({ message: 'This is an alert message.', buttons: ['OK'], }); - return alert.present(); + await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, async presentAlertMultipleButtons() { diff --git a/core/src/components/alert/usage/angular.md b/core/src/components/alert/usage/angular.md index 63cc4dcad9..f413bf34b2 100644 --- a/core/src/components/alert/usage/angular.md +++ b/core/src/components/alert/usage/angular.md @@ -21,6 +21,9 @@ export class AlertExample { }); await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } async presentAlertMultipleButtons() { diff --git a/core/src/components/alert/usage/javascript.md b/core/src/components/alert/usage/javascript.md index f3204b4464..6df575bcf6 100644 --- a/core/src/components/alert/usage/javascript.md +++ b/core/src/components/alert/usage/javascript.md @@ -8,7 +8,10 @@ function presentAlert() { alert.buttons = ['OK']; document.body.appendChild(alert); - return alert.present(); + await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } function presentAlertMultipleButtons() { diff --git a/core/src/components/alert/usage/stencil.md b/core/src/components/alert/usage/stencil.md index 64f5c9ce75..9fa323a457 100644 --- a/core/src/components/alert/usage/stencil.md +++ b/core/src/components/alert/usage/stencil.md @@ -18,6 +18,9 @@ export class AlertExample { }); await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } async presentAlertMultipleButtons() { diff --git a/core/src/components/alert/usage/vue.md b/core/src/components/alert/usage/vue.md index 61ca1b1fc7..018ed60ec9 100644 --- a/core/src/components/alert/usage/vue.md +++ b/core/src/components/alert/usage/vue.md @@ -24,7 +24,10 @@ export default defineComponent({ message: 'This is an alert message.', buttons: ['OK'], }); - return alert.present(); + await alert.present(); + + const { role } = await alert.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, async presentAlertMultipleButtons() { diff --git a/core/src/components/popover/readme.md b/core/src/components/popover/readme.md index b62156f9db..0c4f7137c0 100644 --- a/core/src/components/popover/readme.md +++ b/core/src/components/popover/readme.md @@ -62,7 +62,10 @@ export class PopoverExample { event: ev, translucent: true }); - return await popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } ``` @@ -106,7 +109,11 @@ function presentPopover(ev) { translucent: true }); document.body.appendChild(popover); - return popover.present(); + + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` @@ -216,7 +223,10 @@ export class PopoverExample { event: ev, translucent: true }); - return await popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { @@ -300,7 +310,10 @@ export default { event: ev, translucent: true }) - return popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, } diff --git a/core/src/components/popover/usage/angular.md b/core/src/components/popover/usage/angular.md index 4a8b082963..d689402eba 100644 --- a/core/src/components/popover/usage/angular.md +++ b/core/src/components/popover/usage/angular.md @@ -18,7 +18,10 @@ export class PopoverExample { event: ev, translucent: true }); - return await popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } ``` diff --git a/core/src/components/popover/usage/javascript.md b/core/src/components/popover/usage/javascript.md index 6141a1ec94..48f925f53a 100644 --- a/core/src/components/popover/usage/javascript.md +++ b/core/src/components/popover/usage/javascript.md @@ -29,6 +29,10 @@ function presentPopover(ev) { translucent: true }); document.body.appendChild(popover); - return popover.present(); + + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` diff --git a/core/src/components/popover/usage/stencil.md b/core/src/components/popover/usage/stencil.md index ed43652236..9ccf976fe5 100644 --- a/core/src/components/popover/usage/stencil.md +++ b/core/src/components/popover/usage/stencil.md @@ -15,7 +15,10 @@ export class PopoverExample { event: ev, translucent: true }); - return await popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { diff --git a/core/src/components/popover/usage/vue.md b/core/src/components/popover/usage/vue.md index c83f6b6d58..53d34b1a8a 100644 --- a/core/src/components/popover/usage/vue.md +++ b/core/src/components/popover/usage/vue.md @@ -40,7 +40,10 @@ export default { event: ev, translucent: true }) - return popover.present(); + await popover.present(); + + const { role } = await popover.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, } diff --git a/core/src/components/toast/readme.md b/core/src/components/toast/readme.md index 9ca8a37938..980c8951ec 100644 --- a/core/src/components/toast/readme.md +++ b/core/src/components/toast/readme.md @@ -61,7 +61,10 @@ export class ToastExample { } ] }); - toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } @@ -103,7 +106,10 @@ async function presentToastWithOptions() { ]; document.body.appendChild(toast); - return toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` @@ -242,7 +248,10 @@ export class ToastExample { } ] }); - toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { @@ -306,7 +315,10 @@ export default { } ] }) - return toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, } diff --git a/core/src/components/toast/usage/angular.md b/core/src/components/toast/usage/angular.md index c5b47bb01e..1a51559507 100644 --- a/core/src/components/toast/usage/angular.md +++ b/core/src/components/toast/usage/angular.md @@ -41,7 +41,10 @@ export class ToastExample { } ] }); - toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } } diff --git a/core/src/components/toast/usage/javascript.md b/core/src/components/toast/usage/javascript.md index 98b9017806..4d6e1b2460 100644 --- a/core/src/components/toast/usage/javascript.md +++ b/core/src/components/toast/usage/javascript.md @@ -31,6 +31,9 @@ async function presentToastWithOptions() { ]; document.body.appendChild(toast); - return toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } ``` diff --git a/core/src/components/toast/usage/stencil.md b/core/src/components/toast/usage/stencil.md index a189df9cf3..717ff2916d 100644 --- a/core/src/components/toast/usage/stencil.md +++ b/core/src/components/toast/usage/stencil.md @@ -38,7 +38,10 @@ export class ToastExample { } ] }); - toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); } render() { diff --git a/core/src/components/toast/usage/vue.md b/core/src/components/toast/usage/vue.md index 9d8bea3ee2..b1e7b5192c 100644 --- a/core/src/components/toast/usage/vue.md +++ b/core/src/components/toast/usage/vue.md @@ -45,7 +45,10 @@ export default { } ] }) - return toast.present(); + await toast.present(); + + const { role } = await toast.onDidDismiss(); + console.log('onDidDismiss resolved with role', role); }, }, }