xtf-toast

组件说明

xtf-toast 是轻提示，用于短暂展示操作结果、警告或加载状态。当前实现由 show 控制显示、通过 update:show 等事件反馈交互、提供实例方法。

• 实际 Demo 路由：#/pages/components/xtf-toast/index
• Demo 源码

---

基础用法

1. 最小可用

提供能够直接看到或操作组件的最少业务内容。

<template>
  <view class="doc-minimum">
    <XtfToast text="示例内容" :show="true" :duration="0" />
  </view>
</template>

<script setup lang="uts">
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件

使用组件真实数据入口，并记录当前源码声明的主要事件。

<template>
  <view class="doc-core">
    <XtfToast text="示例内容" :show="true" :duration="0" @open="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-toast:open", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 show 状态

运行时切换 show，观察组件对应状态变化。

<template>
  <view class="doc-dynamic">
    <XtfToast text="示例内容" :duration="0" :show="state" />
    <button class="doc-action-button" @click="toggleState">切换 show</button>
    <text class="doc-state-text">show: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"

import { ref } from "vue"

const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 定制 icon 插槽

使用源码真实声明的 icon slot 替换对应内容。

<template>
  <view class="doc-slot">
    <XtfToast text="示例内容" :show="true" :duration="0">
      <template #icon><text class="doc-content-text">自定义 icon 内容</text></template>
    </XtfToast>
  </view>
</template>

<script setup lang="uts">
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"

</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

5. 调用 open()

打开组件；签名为 open(options: UTSJSONObject = {}): void。

<template>
  <view class="doc-method">
    <XtfToast text="示例内容" :show="true" :duration="0" ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">打开组件</button>
  </view>
</template>

<script setup lang="uts">
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

6. Manager 服务调用

先挂载 service 宿主，再调用对应 manager 的实际显示 API。

<template>
  <view class="doc-service">
    <XtfToast text="示例内容" :duration="0" service />
    <button class="doc-action-button" @click="openService">服务式调用</button>
  </view>
</template>

<script setup lang="uts">
import { toastManager } from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/service.uts"
import XtfToast from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/xtf-toast.uvue"


function openService(): void { toastManager.success('保存成功'); console.log("toastManager 已调用") }
</script>

<style>
.doc-service { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
service	boolean	false	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 133、script 行 235、script 行 246、service.uts 行 30	需要控制显示、可用性或交互状态时设置。
show	boolean	false	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 128、script 行 133、script 行 134、script 行 247	需要控制显示、可用性或交互状态时设置。
message	string	""	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 97、script 行 132	需要提供业务文案或图标内容时设置。
text	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 97、script 行 132	需要提供业务文案或图标内容时设置。
title	string	""	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 132、template 行 16	需要提供业务文案或图标内容时设置。
type	string	"info"	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 79、script 行 132、template 行 11	需要覆盖组件默认业务值时设置。
duration	number	2400	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 132、script 行 187、script 行 191	需要覆盖组件默认业务值时设置。
position	string	"center"	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 94、script 行 132	需要覆盖组件默认业务值时设置。
offsetX	number	0	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 161、script 行 162	需要覆盖组件默认业务值时设置。
offsetY	number	0	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 161、script 行 162	需要覆盖组件默认业务值时设置。
customTop	number	24	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 121	需要覆盖组件默认业务值时设置。
customLeft	number	24	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 122	需要覆盖组件默认业务值时设置。
overlay	boolean	false	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 116、template 行 2	需要控制显示、可用性或交互状态时设置。
closeOnClickOverlay	boolean	false	开关对应显示或交互行为；消费位置：script 行 240	需要覆盖组件默认业务值时设置。
showIcon	boolean	true	设置对应区域的图标名称；消费位置：template 行 9	需要控制显示、可用性或交互状态时设置。
icon	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 99	需要提供业务文案或图标内容时设置。
allowHtml	boolean	false	兼容接收，当前实现未消费/不产生行为	仅用于兼容现有调用；当前版本不应依赖其效果。
styleType	string	"solid"	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 84、script 行 132	需要覆盖组件默认业务值时设置。
layout	string	"inline"	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 89、script 行 132	需要调整布局或视觉表现时设置。
closeable	boolean	false	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 110、template 行 6	需要覆盖组件默认业务值时设置。
beforeClose	(payload: UTSJSONObject) => boolean | Promise<boolean>	null	提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 223	需要接入业务守卫、转换或过滤逻辑时设置。
zIndex	number	2100	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 113	需要调整布局或视觉表现时设置。
customStyle	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 124	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
update:show	requestClose 内触发（script 行 234）；参数表达式：false；前置 guard：disposed || !rendered.value || closing || closePending、disposed || id != motionId.value、!allowed open 内触发（script 行 248）；参数表达式：true；前置 guard：disposed、props.service	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
open	openToast 内触发（script 行 174）；参数表达式：无回调参数；前置 guard：disposed	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
opened	setup 内触发（script 行 181）；参数表达式：无回调参数 setup 内触发（script 行 184）；参数表达式：无回调参数；前置 guard：disposed || motionId.value != id	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
close	closeToast 内触发（script 行 202）；参数表达式：{ source }；前置 guard：disposed || !rendered.value || closing	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
closed	finish 内触发（script 行 207）；参数表达式：{ source }；前置 guard：disposed || id != motionId.value	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
blocked-close	requestClose 内触发（script 行 231）；参数表达式：payload；前置 guard：disposed || !rendered.value || closing || closePending、disposed || id != motionId.value、!allowed	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
click-overlay	handleOverlay 内触发（script 行 239）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

插槽	Scope 参数	实际渲染位置
icon	无 scope 参数	仅在模板对应 <slot> 渲染位置生效。

---

方法

实例方法

方法	签名 / 返回值	调用边界
open	open(options: UTSJSONObject = {}): void	打开组件；通过组件 ref 调用，参数和返回值按签名处理。
close	close(): void	请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。

公开状态

状态	类型 / 包装	读取边界
-	-	当前组件没有公开状态。

Manager 宿主与导入

• 宿主：在页面中挂载 <XtfToast service />。
• 导入：import { toastManager } from "@/uni_modules/xtf-linkuiunix/components/xtf-toast/service.uts"。
• 调用：基础用法中的 Manager 示例调用真实显示 API，而不是只读取 getState()。
• 返回：manager 返回当前状态快照或通知项，不是等待用户操作的 Promise；用户结果继续监听宿主事件。
• toastManager.clear()（close 的同义入口）只关闭当前项，保留 queue，并在 nextTick 推进下一项；推进中重复 clear 不跳过队列项。clearAll() 关闭当前项、清空队列并使待推进任务失效，卸载清理应按业务所有权选择。非 queue 的 show 会替换当前项并清空旧队列。

---

主题说明

• var(--xtf-toast-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-toast-status)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。

---

平台与实现边界

• 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
• Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
• 本文按当前源码生成，不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
• 当前仅兼容接收、未发现运行消费的 props：allowHtml。
• 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。