Skip to content

xtf-tabbar ​

组件说明 ​

xtf-tabbar 是底部标签栏,用于切换应用一级导航入口。当前实现读取 list 数据、通过 input 等事件反馈交互。

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

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfTabbar :list="fixture" :fixed="false" :safe-area-inset-bottom="false" />
  </view>
</template>

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

const fixture = [{ text: '首页', icon: 'home' }, { text: '账单', icon: 'receipt_long' }, { text: '我的', icon: 'account_circle' }] as Array<any>
</script>

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

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

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

vue
<template>
  <view class="doc-core">
    <XtfTabbar :list="fixture" :fixed="false" :safe-area-inset-bottom="false" @input="onPrimaryEvent" />
  </view>
</template>

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

const fixture = [{ text: '首页', icon: 'home' }, { text: '账单', icon: 'receipt_long' }, { text: '我的', icon: 'account_circle' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-tabbar:input", payload) }
</script>

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

3. 动态 borderTop 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfTabbar :list="fixture" :fixed="false" :safe-area-inset-bottom="false" :border-top="state" />
    <button class="doc-action-button" @click="toggleState">切换 borderTop</button>
    <text class="doc-state-text">borderTop: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"
const fixture = [{ text: '首页', icon: 'home' }, { text: '账单', icon: 'receipt_long' }, { text: '我的', icon: 'account_circle' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("borderTop", 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. 数字徽标、圆点与固定预览 ​

切换 fixed 时同时为页面正文预留底部空间。Demo 将固定预览放在滚动内容外;徽标所在布局允许溢出,但业务祖先的 overflow:hidden 仍可能裁切。

vue
<template>
  <view class="doc-tabbar-fixed">
    <view :style="contentStyle"><text class="doc-content-text">正文底部预留固定导航及安全区空间</text><button class="doc-action-button" @click="toggleState">切换固定预览</button></view><XtfTabbar :value="current" :list="fixture" :fixed="state" :safe-area-inset-bottom="state" variant="floating" icon-position="top" :height="144" @input="updateCurrent" @click-item="onItem" />
  </view>
</template>

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

import { computed, ref } from "vue"
const fixture = [{ text: "首页", icon: "home" }, { text: "消息", icon: "chat", badge: 10 }, { text: "我的", icon: "account_circle", dot: true }] as Array<any>
const current = ref(0)
const state = ref(false)
const contentStyle = computed((): UTSJSONObject => ({ paddingBottom: state.value ? (uni.upx2px(192) + (uni.getWindowInfo().safeAreaInsets?.bottom ?? 0)).toString() + "px" : "0px" }))
function toggleState(): void { state.value = !state.value; console.log("fixed", state.value) }
function updateCurrent(value: number): void { current.value = value }
function onItem(payload: any): void { console.log("click-item", payload) }
</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
modelValuenumberundefined参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37需要覆盖组件默认业务值时设置。
valuenumber0参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37需要覆盖组件默认业务值时设置。
listany[]() => []参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 93、script 行 98、template 行 5数据驱动或选项渲染场景。
variantstring'solid'参与组件运行逻辑;源码在 14 处读取该值;消费位置:script 行 39、script 行 48、script 行 53、script 行 54需要调整布局或视觉表现时设置。
shapestring'auto'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 39需要覆盖组件默认业务值时设置。
activeColorstring''设置对应区域的颜色;消费位置:script 行 35需要调整布局或视觉表现时设置。
inactiveColorstring''设置对应区域的颜色;消费位置:script 行 36需要调整布局或视觉表现时设置。
activeTextColorstring''设置对应区域的颜色;消费位置:script 行 97需要调整布局或视觉表现时设置。
inactiveTextColorstring''设置对应区域的颜色;消费位置:script 行 97需要调整布局或视觉表现时设置。
iconSizestring | number48设置对应元素尺寸;消费位置:script 行 42需要调整布局或视觉表现时设置。
iconOnlySizestring | number''设置对应元素尺寸;消费位置:script 行 42、script 行 62需要调整布局或视觉表现时设置。
mediaTypestring'auto'参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 65需要覆盖组件默认业务值时设置。
imageSizestring | number48设置对应元素尺寸;消费位置:script 行 62需要调整布局或视觉表现时设置。
imageRadiusstring | number16参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 63需要调整布局或视觉表现时设置。
imageModestring'aspectFit'参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 12需要覆盖组件默认业务值时设置。
backgroundColorstring''设置对应区域的颜色;消费位置:script 行 53需要调整布局或视觉表现时设置。
borderTopbooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3需要覆盖组件默认业务值时设置。
fixedbooleantrue参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 50、script 行 51需要覆盖组件默认业务值时设置。
safeAreaInsetBottombooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 24需要覆盖组件默认业务值时设置。
routebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 125需要覆盖组件默认业务值时设置。
zIndexnumber100参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 52需要覆盖组件默认业务值时设置。
heightstring | number110参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 58需要覆盖组件默认业务值时设置。
paddingstring | number''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 59需要覆盖组件默认业务值时设置。
itemDirectionstring'auto'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 40需要覆盖组件默认业务值时设置。
iconPositionstring'start'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 40、script 行 41需要覆盖组件默认业务值时设置。
labelVisiblebooleantrue参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 42、script 行 62、template 行 19需要提供业务文案或图标内容时设置。
labelSpacingstring | number''参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95需要提供业务文案或图标内容时设置。
itemAlignstring'center'参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 73需要覆盖组件默认业务值时设置。
gapstring | number''参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95、template 行 7需要覆盖组件默认业务值时设置。
itemPaddingstring | number''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 74需要覆盖组件默认业务值时设置。
itemRadiusstring | number''参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 74、script 行 113需要调整布局或视觉表现时设置。
activeInsetstring | number''提供当前受控状态;是否回写以事件表为准;消费位置:script 行 82、script 行 111需要覆盖组件默认业务值时设置。
activeRadiusstring | number''提供当前受控状态;是否回写以事件表为准;消费位置:script 行 83、script 行 113需要调整布局或视觉表现时设置。
stackPaddingTopstring | number''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 78需要覆盖组件默认业务值时设置。
stackPaddingBottomstring | number''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 79需要覆盖组件默认业务值时设置。
iconWrapMinHeightstring | number''设置对应区域高度;消费位置:script 行 89需要调整布局或视觉表现时设置。
activeItemBackgroundstring''提供当前受控状态;是否回写以事件表为准;消费位置:script 行 75需要覆盖组件默认业务值时设置。
inactiveItemBackgroundstring''提供当前受控状态;是否回写以事件表为准;消费位置:script 行 75需要覆盖组件默认业务值时设置。
showIndicatorbooleanfalse开关对应显示或交互行为;消费位置:script 行 81、template 行 9需要控制显示、可用性或交互状态时设置。
indicatorStylestring'pill'覆盖或追加对应内部区域的样式对象;消费位置:script 行 81、script 行 109、script 行 119、script 行 120需要调整布局或视觉表现时设置。
indicatorColorstring''设置对应区域的颜色;消费位置:script 行 114、script 行 121需要调整布局或视觉表现时设置。
indicatorWidthstring | number''设置对应区域宽度;消费位置:script 行 119需要调整布局或视觉表现时设置。
indicatorHeightstring | number''设置对应区域高度;消费位置:script 行 120需要调整布局或视觉表现时设置。
indicatorPositionstring'auto'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 116需要覆盖组件默认业务值时设置。
indicatorOffsetstring | number''参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 117、script 行 118需要覆盖组件默认业务值时设置。
itemClassstring''追加到对应内部区域的 class;消费位置:template 行 6需要调整布局或视觉表现时设置。
itemStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 86需要调整布局或视觉表现时设置。
activeItemClassstring''追加到对应内部区域的 class;消费位置:template 行 6需要调整布局或视觉表现时设置。
activeItemStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 86需要调整布局或视觉表现时设置。
labelClassstring''追加到对应内部区域的 class;消费位置:template 行 20需要调整布局或视觉表现时设置。
labelStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 106需要调整布局或视觉表现时设置。
activeLabelClassstring''追加到对应内部区域的 class;消费位置:template 行 20需要调整布局或视觉表现时设置。
activeLabelStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 106需要调整布局或视觉表现时设置。
iconWrapStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 89需要调整布局或视觉表现时设置。
activeIconWrapStyleany''覆盖或追加对应内部区域的样式对象;消费位置:script 行 89需要调整布局或视觉表现时设置。
customClassstring''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStyleany''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
inputselect 内触发(script 行 134);参数表达式:index;前置 guard:item.disabled、props.route && item.url(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:valueselect 内触发(script 行 135);参数表达式:index;前置 guard:item.disabled、props.route && item.url(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValueselect 内触发(script 行 136);参数表达式:index;前置 guard:item.disabled、props.route && item.url(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changeselect 内触发(script 行 137);参数表达式:{ index, item };前置 guard:item.disabled、props.route && item.url(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
click-itemselect 内触发(script 行 139);参数表达式:{ index, item };前置 guard:item.disabled、props.route && item.url(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-shadow-card):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。

平台与实现边界 ​

  • 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
  • Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
  • 本文按当前源码生成,不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
  • badge/dot 的内部布局已允许 overflow:visible,标签自身仍截断;祖先容器的 overflow:hidden 仍可能裁切徽标。Demo 的 fixed 预览在滚动内容外,正文单独预留导航高度与安全区;文档内嵌示例默认 fixed=false,固定预览例显式切换。fixed 与 safeAreaInsetBottom 默认均为 true,组件不会替业务自动预留正文空间。
  • 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

MIT Licensed