Merge pull request #3723 from abpframework/confirmation-toaster-patch-1

Updated option descriptions for confirmation and toaster services
pull/3706/head
Mehmet Erim 5 years ago committed by GitHub
commit 414df896af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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 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.
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)
- [Toast Overlay](./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<Toaster.ToastOptions> = {
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)

Loading…
Cancel
Save