Skip to content

xtf-loading ​

组件说明 ​

xtf-loading 是加载指示器,用于展示行内或全屏加载反馈。当前实现由 show 控制显示、提供实例方法。

  • 实际 Demo 路由:#/pages/components/xtf-loading/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfLoading :show="true" text="加载中" />
  </view>
</template>

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

</script>

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

2. 核心数据与主要事件 ​

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

vue
<template>
  <view class="doc-core">
    <XtfLoading :show="true" text="加载中" :key="renderKey" />
    <button class="doc-action-button" @click="remountComponent">重新挂载组件</button>
  </view>
</template>

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

import { ref } from "vue"
const renderKey = ref(0)
function remountComponent(): void { renderKey.value += 1; console.log("xtf-loading 重新挂载", renderKey.value) }
</script>

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

3. 动态 show 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfLoading text="加载中" :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 XtfLoading from "@/uni_modules/xtf-linkuiunix/components/xtf-loading/xtf-loading.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. 调用 open() ​

打开组件;签名为 open(options: XtfLoadingOptions = {} as XtfLoadingOptions): void。

vue
<template>
  <view class="doc-method">
    <XtfLoading :show="true" text="加载中" service ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">打开组件</button>
  </view>
</template>

<script setup lang="uts">
import XtfLoading from "@/uni_modules/xtf-linkuiunix/components/xtf-loading/xtf-loading.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>

5. Manager 服务调用 ​

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

vue
<template>
  <view class="doc-service">
    <XtfLoading text="加载中" service />
    <button class="doc-action-button" @click="openService">服务式调用</button>
  </view>
</template>

<script setup lang="uts">
import { loadingManager } from "@/uni_modules/xtf-linkuiunix/libs/loading-manager.uts"
import XtfLoading from "@/uni_modules/xtf-linkuiunix/components/xtf-loading/xtf-loading.uvue"


function openService(): void { loadingManager.show({ text: '正在同步', mode: 'fullscreen', overlay: true }); console.log("loadingManager 已调用") }
</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
showbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要控制显示、可用性或交互状态时设置。
textstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要提供业务文案或图标内容时设置。
typestring"spinner"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要覆盖组件默认业务值时设置。
sizestring | number""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要覆盖组件默认业务值时设置。
themestring"primary"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要调整布局或视觉表现时设置。
modestring"inline"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要覆盖组件默认业务值时设置。
overlaybooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要控制显示、可用性或交互状态时设置。
verticalbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要覆盖组件默认业务值时设置。
delaystring | number0参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18需要调整布局或视觉表现时设置。
servicebooleanfalse参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 18、script 行 66、script 行 67、script 行 72需要控制显示、可用性或交互状态时设置。
animatedbooleantrue参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 33、script 行 69需要覆盖组件默认业务值时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
-当前组件未调用 defineEmits。--

插槽 ​

插槽Scope 参数实际渲染位置
--当前模板没有公开 slot。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
openopen(options: XtfLoadingOptions = {} as XtfLoadingOptions): void打开组件;通过组件 ref 调用,参数和返回值按签名处理。
closeclose(): void请求关闭组件;通过组件 ref 调用,参数和返回值按签名处理。

公开状态 ​

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

Manager 宿主与导入 ​

  • 宿主:在页面中挂载 <XtfLoading service />。
  • 导入:import { loadingManager } from "@/uni_modules/xtf-linkuiunix/libs/loading-manager.uts"。
  • 调用:基础用法中的 Manager 示例调用真实显示 API,而不是只读取 getState()。
  • 返回:manager 返回当前状态快照或通知项,不是等待用户操作的 Promise;用户结果继续监听宿主事件。

主题说明 ​

  • var(--xtf-color-danger):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-loading-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-loading-size):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-loading-z-index):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。

平台与实现边界 ​

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

MIT Licensed