useToast

一个用于在应用程序中显示吐司通知的 Composable。

用法

使用自动导入的 useToast composable 来显示 Toast 通知。

<script setup lang="ts">
const toast = useToast()
</script>
  • useToast composable 使用 Nuxt 的 useState 来管理吐司状态，确保应用程序中的响应性。
  • 一次最多显示 5 个吐司。当添加一个新吐司会超出此限制时，最旧的吐司将自动删除。
  • 当移除一个吐司时，会有一个 200ms 的延迟，然后它才真正从状态中移除，以便进行退出动画。
请务必使用 App 组件包裹您的应用程序，该组件使用了我们的Toaster组件，该组件使用了ToastProvider组件（来自 Reka UI）。
在 Toast 组件文档中了解如何自定义吐司的外观和行为。

API

useToast()

useToast composable 提供全局管理吐司通知的方法。

add()

add(toast: Partial<Toast>): Toast

添加新的吐司通知。

参数

toast
Partial<Toast> 必填
一个包含以下属性的局部 Toast 对象

返回: 添加的完整 Toast 对象。

<script setup lang="ts">
const toast = useToast()

function showToast() {
  toast.add({
    title: 'Success',
    description: 'Your action was completed successfully.',
    color: 'success'
  })
}
</script>

update()

update(id: string | number, toast: Partial<Toast>): void

更新现有的吐司通知。

参数

id
string | number 必填
要更新的吐司的唯一标识符。
toast
Partial<Toast> 必填
一个包含要更新属性的局部 Toast 对象。
<script setup lang="ts">
const toast = useToast()

function updateToast(id: string | number) {
  toast.update(id, {
    title: 'Updated Toast',
    description: 'This toast has been updated.'
  })
}
</script>

remove()

remove(id: string | number): void

移除吐司通知。

参数

id
string | number 必填
要移除的吐司的唯一标识符。
<script setup lang="ts">
const toast = useToast()

function removeToast(id: string | number) {
  toast.remove(id)
}
</script>

clear()

clear(): void

移除所有吐司通知。

<script setup lang="ts">
const toast = useToast()

function clearAllToasts() {
  toast.clear()
}
</script>

toasts

toasts: Ref<Toast[]>

  • 类型: Ref<Toast[]>
  • 描述: 一个包含所有当前吐司通知的响应式数组。

useOverlay

一个用于以编程方式控制覆盖层的 Composable。