From 56fef10c2b9aa231cec2281fd795a3e0a461deed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20Arman=20=C3=96zak?= Date: Thu, 23 Apr 2020 17:44:15 +0300 Subject: [PATCH 1/3] docs: update option descriptions --- docs/en/UI/Angular/Confirmation-Service.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en/UI/Angular/Confirmation-Service.md b/docs/en/UI/Angular/Confirmation-Service.md index d42c323227..2d28d04b2b 100644 --- a/docs/en/UI/Angular/Confirmation-Service.md +++ b/docs/en/UI/Angular/Confirmation-Service.md @@ -26,7 +26,7 @@ You can use the `success`, `warn`, `error`, and `info` methods of `ConfirmationS ### How to Display a Confirmation Popup ```js -const confirmationStatus$ = this.confirmation.success('Message', 'Title') +const confirmationStatus$ = this.confirmation.success('Message', 'Title'); ``` - The `ConfirmationService` methods accept three parameters that are `message`, `title`, and `options`. @@ -34,7 +34,7 @@ const confirmationStatus$ = this.confirmation.success('Message', 'Title') ### How to Listen Closing Event -You can subscribe the confirmation closing event like below: +You can subscribe to the confirmation closing event like below: ```js import { Confirmation, ConfirmationService } from '@abp/ng.theme.shared'; @@ -56,7 +56,7 @@ this.confirmation - `Confirmation.Status.dismiss` is a closing event value that will be emitted when the popup is closed by pressing the escape. -If the status is not important for you, you may not listen the closing event: +If you are not interested in the confirmation status, you do not have to subscribe to the returned observable: ```js this.confirmation.error('You are not authorized.', 'Error'); @@ -83,14 +83,14 @@ this.confirmation.warn( ); ``` -- `hideCancelBtn` option is the boolean value that allows the cancel button to be displayed or hidden. Default value is `false` -- `hideYesBtn` option is the boolean value that allows the confirm button to be displayed or hidden. Default value is `false` -- `cancelText` is the text of the cancel button. A localization key or localization object can be passed. Default value is `AbpUi::Cancel` -- `yesText` is the text of the confirm button. A localization key or localization object can be passed. Default value is `AbpUi::Yes` -- `messageLocalizationParams` is the interpolation parameters of the message localization. -- `titleLocalizationParams` is the interpolation parameters of the title localization. +- `hideCancelBtn` option is the boolean value that hides or displays the "Cancel" button (hides if `true`). Default value is `false` +- `hideYesBtn` option is the boolean value that hides or displays the "Confirm" button (hides if `true`). Default value is `false` +- `cancelText` is the text of the "Cancel" button. A localization key or localization object can be passed. Default value is `AbpUi::Cancel` +- `yesText` is the text of the "Confirm" button. A localization key or localization object can be passed. Default value is `AbpUi::Yes` +- `messageLocalizationParams` is the interpolation parameters for the localization of the message. +- `titleLocalizationParams` is the interpolation parameters for the localization of the title. -With the above options, the confirmation popup looks like this: +With the options above, the confirmation popup looks like this: ![confirmation](./images/confirmation.png) @@ -160,4 +160,4 @@ clear( ## What's Next? -- [Toast Overlay](./Toaster-Service.md) \ No newline at end of file +- [Toast Overlay](./Toaster-Service.md) From f35da7376bc8a02bedce4c87d8e3432fcf274a50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20Arman=20=C3=96zak?= Date: Thu, 23 Apr 2020 17:54:59 +0300 Subject: [PATCH 2/3] docs: update option descriptions --- docs/en/UI/Angular/Toaster-Service.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/en/UI/Angular/Toaster-Service.md b/docs/en/UI/Angular/Toaster-Service.md index 669ee3b33b..191f0b34fd 100644 --- a/docs/en/UI/Angular/Toaster-Service.md +++ b/docs/en/UI/Angular/Toaster-Service.md @@ -26,7 +26,7 @@ You can use the `success`, `warn`, `error`, and `info` methods of `ToasterServic ### How to Display a Toast Overlay ```js -this.toast.success('Message', 'Title') +this.toast.success('Message', 'Title'); ``` - The `ToasterService` methods accept three parameters that are `message`, `title`, and `options`. @@ -55,15 +55,15 @@ const options: Partial = { this.toaster.error('AbpUi::EntityNotFoundErrorMessage', 'AbpUi::Error', options); ``` -- `life` option is the value in milliseconds that determines the closing time. Default value is `5000` -- `sticky` option is the boolean value. If the value passed `true`, toast overlay keep on the screen by ignoring the life option. Default value is `false` -- `closable` option is the boolean value that displays the close icon over the toast overlay or not. Default value is `true`. -- `tapToDismiss` option is the boolean value that allows closing the toast overlay by clicking over. Default value is `false`. -- `yesText` is the text of the confirm button. A localization key or localization object can be passed. Default value is `AbpUi::Yes` -- `messageLocalizationParams` is the interpolation parameters of the message localization. -- `titleLocalizationParams` is the interpolation parameters of the title localization. +- `life` option is the closing time in milliseconds. Default value is `5000`. +- `sticky` option keeps toast overlay on the screen by ignoring the `life` option when `true`. Default value is `false`. +- `closable` option displays the close icon on the toast overlay when it is `true`. Default value is `true`. +- `tapToDismiss` option, when `true`, allows closing the toast overlay by clicking over it. Default value is `false`. +- `yesText` is the text of the confirmation button. A localization key or localization object can be passed. Default value is `AbpUi::Yes`. +- `messageLocalizationParams` is the interpolation parameters for the localization of the message. +- `titleLocalizationParams` is the interpolation parameters for the localization of the title. -With the above options, the toast overlay looks like this: +With the options above, the toast overlay looks like this: ![toast](./images/toast.png) From 02d2e1f93f39f3c9116f2be1426cace0144f099f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20Arman=20=C3=96zak?= Date: Thu, 23 Apr 2020 17:57:52 +0300 Subject: [PATCH 3/3] docs: reword option descriptions --- docs/en/UI/Angular/Confirmation-Service.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/UI/Angular/Confirmation-Service.md b/docs/en/UI/Angular/Confirmation-Service.md index 2d28d04b2b..a8d2c4c2a7 100644 --- a/docs/en/UI/Angular/Confirmation-Service.md +++ b/docs/en/UI/Angular/Confirmation-Service.md @@ -83,10 +83,10 @@ this.confirmation.warn( ); ``` -- `hideCancelBtn` option is the boolean value that hides or displays the "Cancel" button (hides if `true`). Default value is `false` -- `hideYesBtn` option is the boolean value that hides or displays the "Confirm" button (hides if `true`). Default value is `false` -- `cancelText` is the text of the "Cancel" button. A localization key or localization object can be passed. Default value is `AbpUi::Cancel` -- `yesText` is the text of the "Confirm" button. A localization key or localization object can be passed. Default value is `AbpUi::Yes` +- `hideCancelBtn` option hides the cancellation button when `true`. Default value is `false` +- `hideYesBtn` option hides the confirmation button when `true`. Default value is `false` +- `cancelText` is the text of the cancellation button. A localization key or localization object can be passed. Default value is `AbpUi::Cancel` +- `yesText` is the text of the confirmation button. A localization key or localization object can be passed. Default value is `AbpUi::Yes` - `messageLocalizationParams` is the interpolation parameters for the localization of the message. - `titleLocalizationParams` is the interpolation parameters for the localization of the title.