Toast API · Needless UI

导入

import-toast.ts

import { NuiToaster, NuiToasterRegion } from '@needless-ui/angular/toast';

用来显示 Toast 的服务。可以在任何地方注入。

NuiToaster: 属性
名称	类型	说明
`toasts`方法	`Signal<readonly NuiToast[]>`	屏幕上的所有 Toast，最新的排在最前面。
`show`方法	`(options: NuiToastOptions \| string) => NuiToastRef`	显示一条 Toast。传入标题，或传入包含描述、色调、持续时间、操作或 id 的选项。
`success`方法	`(title, options?) => NuiToastRef`	显示一条成功 Toast。
`warning`方法	`(title, options?) => NuiToastRef`	显示一条警告 Toast。
`danger`方法	`(title, options?) => NuiToastRef`	显示一条危险 Toast。它会停留 8 秒，并会被立即播报。
`promise`方法	`(promise, messages) => Promise`	在 Promise 敲定之前显示加载中的 Toast，之后显示相应的成功或危险消息。
`dismiss`方法	`(id?: string) => void`	关闭一条 Toast，或关闭全部。

Toast 出现的区域。在应用外壳中放置一次即可。

NuiToasterRegion: 属性
名称	类型	默认值	说明
`position`输入	`'top-start' \| 'top-center' \| 'top-end' \| 'bottom-start' \| 'bottom-center' \| 'bottom-end'`	`'bottom-end'`	视口的某个角或某条边。起始端和末端跟随文本方向。
`expanded`输入	`boolean`	`false`	让堆叠始终保持展开。
`label`输入	`string`	`'Notifications (Alt+T)'`	区域的可访问名称。请在其中说明如何跳转到该区域。
`closeLabel`输入	`string`	`'Dismiss'`	关闭按钮的可访问名称。
`hotkey`输入	`string`	`'KeyT'`	与 Alt 组合使用、将焦点移到最新一条 Toast 的按键，以 `KeyboardEvent.code` 表示。