- Toast轻提示
- 规则
- 代码演示
- API
Toast轻提示
一种轻量级反馈/提示,可以用来显示不会打断用户操作的内容,适合用于页面转场、数据交互的等场景中。
规则
- 一次只显示一个 toast。
- 有 Icon 的 Toast,字数为 4-6 个;没有 Icon 的 Toast,字数不宜超过 14 个。
代码演示
基本用法
最简单的用法。
import { Component } from '@angular/core';
import { ToastService } from 'ng-zorro-antd-mobile';
@Component({
selector: 'demo-toast-basic',
template: `
<WingBlank>
<div Button (onClick)="showToast()">text only</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="showToastNoMask()">without mask</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="showToastTop()">position top</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="showToastBottom()">position bottom</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="showCustomIcon(content)">custom content</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="successToast()">success</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="failToast()">fail</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="offline()">network failure</div>
<WhiteSpace></WhiteSpace>
<div Button (onClick)="loadingToast()">loading</div>
<WhiteSpace></WhiteSpace>
<ng-template #content>
<p>toast的内容</p>
<p>toast的内容</p>
</ng-template>
</WingBlank>
`
})
export class DemoToastBasicComponent {
constructor(private _toast: ToastService) {}
showToast() {
const toast = ToastService.show('This is a toast tips !!!', 0);
setTimeout(() => {
ToastService.hide();
}, 3000);
}
showToastNoMask() {
const toast = ToastService.info('Toast without mask !!!', 4000, null, false);
}
showToastTop() {
const toast = ToastService.info('Toast position top', 4000, null, false, 'top');
}
showToastBottom() {
const toast = ToastService.info('Toast position top', 4000, null, false, 'bottom');
}
showCustomIcon(event) {
const toast = ToastService.info(event);
}
successToast() {
const toast = ToastService.success('Load success !!!', 3000, () => {
console.log('success');
});
}
failToast() {
const toast = ToastService.fail('Load failed !!!', 1000);
}
offline() {
const toast = ToastService.offline('Network connection failed !!!', 1000);
}
loadingToast() {
const toast = ToastService.loading('Loading...', 3000, () => {
console.log('Load complete !!!');
});
}
}
API
ToastService.success(content, duration, onClose, mask)
ToastService.fail(content, duration, onClose, mask)
ToastService.info(content, duration, onClose, mask)
ToastService.loading(content, duration, onClose, mask)
ToastService.offline(content, duration, onClose, mask)
组件提供了五个静态方法,参数如下:
属性 | 说明 | 类型 | 默认值 |
---|---|---|---|
content | 提示内容 | TemplateRef or String | 无 |
duration | 自动关闭的延时,单位毫秒 | number | 3000 |
onClose | 关闭后回调 | Function | 无 |
mask | 是否显示透明蒙层,防止触摸穿透 | Boolean | true |
position | enum{'top', 'middle', 'bottom'} | string | 'middle' |
注: duration = 0 时,onClose 无效,toast 不会消失;隐藏 toast 需要手动调用 hide
还提供了全局配置和全局销毁方法:
ToastService.hide()