Skip to content

xtf-config-provider ​

组件说明 ​

xtf-config-provider 是全局配置容器,用于向子树提供主题、语言和组件默认配置。当前实现按源码声明的 props 渲染内容。

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

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfConfigProvider >
      <text class="doc-content-text">示例内容</text>
    </XtfConfigProvider>
  </view>
</template>

<script setup lang="uts">
import XtfConfigProvider from "@/uni_modules/xtf-linkuiunix/components/xtf-config-provider/xtf-config-provider.uvue"

</script>

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

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

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

vue
<template>
  <view class="doc-core">
    <XtfConfigProvider :key="renderKey">
      <text class="doc-content-text">示例内容</text>
    </XtfConfigProvider>
    <button class="doc-action-button" @click="remountComponent">重新挂载组件</button>
  </view>
</template>

<script setup lang="uts">
import XtfConfigProvider from "@/uni_modules/xtf-linkuiunix/components/xtf-config-provider/xtf-config-provider.uvue"

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

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

3. 动态 disabled 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfConfigProvider :disabled="state">
      <text class="doc-content-text">示例内容</text>
    </XtfConfigProvider>
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfConfigProvider from "@/uni_modules/xtf-linkuiunix/components/xtf-config-provider/xtf-config-provider.uvue"

import { ref } from "vue"

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

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

4. 定制 default 插槽 ​

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

vue
<template>
  <view class="doc-slot">
    <XtfConfigProvider >
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfConfigProvider>
  </view>
</template>

<script setup lang="uts">
import XtfConfigProvider from "@/uni_modules/xtf-linkuiunix/components/xtf-config-provider/xtf-config-provider.uvue"

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
themeXtfTheme"light"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42、script 行 50需要调整布局或视觉表现时设置。
themeVarsUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46、script 行 54需要覆盖组件默认业务值时设置。
sizeXtfComponentSize"md"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42、script 行 62需要覆盖组件默认业务值时设置。
zIndexnumber2000参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 70需要覆盖组件默认业务值时设置。
durationnumber240参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 74需要覆盖组件默认业务值时设置。
safeAreabooleantrue参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 40、script 行 78需要覆盖组件默认业务值时设置。
ripplebooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 82需要覆盖组件默认业务值时设置。
localeXtfLocale"zh-Hans"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 58需要覆盖组件默认业务值时设置。
directionXtfDirection"ltr"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42、script 行 86需要覆盖组件默认业务值时设置。
componentSizeXtfComponentSize"md"设置对应元素尺寸;消费位置:script 行 66需要调整布局或视觉表现时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 41、script 行 90需要控制显示、可用性或交互状态时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 42需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46需要调整布局或视觉表现时设置。

事件 ​

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

插槽 ​

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

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

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

主题说明 ​

  • var(--xtf-opacity-disabled):组件样式实际读取的主题变量,可在 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