Appearance
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>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | number | undefined | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37 | 需要覆盖组件默认业务值时设置。 |
value | number | 0 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37 | 需要覆盖组件默认业务值时设置。 |
list | any[] | () => [] | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 93、script 行 98、template 行 5 | 数据驱动或选项渲染场景。 |
variant | string | 'solid' | 参与组件运行逻辑;源码在 14 处读取该值;消费位置:script 行 39、script 行 48、script 行 53、script 行 54 | 需要调整布局或视觉表现时设置。 |
shape | string | 'auto' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 39 | 需要覆盖组件默认业务值时设置。 |
activeColor | string | '' | 设置对应区域的颜色;消费位置:script 行 35 | 需要调整布局或视觉表现时设置。 |
inactiveColor | string | '' | 设置对应区域的颜色;消费位置:script 行 36 | 需要调整布局或视觉表现时设置。 |
activeTextColor | string | '' | 设置对应区域的颜色;消费位置:script 行 97 | 需要调整布局或视觉表现时设置。 |
inactiveTextColor | string | '' | 设置对应区域的颜色;消费位置:script 行 97 | 需要调整布局或视觉表现时设置。 |
iconSize | string | number | 48 | 设置对应元素尺寸;消费位置:script 行 42 | 需要调整布局或视觉表现时设置。 |
iconOnlySize | string | number | '' | 设置对应元素尺寸;消费位置:script 行 42、script 行 62 | 需要调整布局或视觉表现时设置。 |
mediaType | string | 'auto' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 65 | 需要覆盖组件默认业务值时设置。 |
imageSize | string | number | 48 | 设置对应元素尺寸;消费位置:script 行 62 | 需要调整布局或视觉表现时设置。 |
imageRadius | string | number | 16 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 63 | 需要调整布局或视觉表现时设置。 |
imageMode | string | 'aspectFit' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 12 | 需要覆盖组件默认业务值时设置。 |
backgroundColor | string | '' | 设置对应区域的颜色;消费位置:script 行 53 | 需要调整布局或视觉表现时设置。 |
borderTop | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3 | 需要覆盖组件默认业务值时设置。 |
fixed | boolean | true | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 50、script 行 51 | 需要覆盖组件默认业务值时设置。 |
safeAreaInsetBottom | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 24 | 需要覆盖组件默认业务值时设置。 |
route | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 125 | 需要覆盖组件默认业务值时设置。 |
zIndex | number | 100 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 52 | 需要覆盖组件默认业务值时设置。 |
height | string | number | 110 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 58 | 需要覆盖组件默认业务值时设置。 |
padding | string | number | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 59 | 需要覆盖组件默认业务值时设置。 |
itemDirection | string | 'auto' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
iconPosition | string | 'start' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 40、script 行 41 | 需要覆盖组件默认业务值时设置。 |
labelVisible | boolean | true | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 42、script 行 62、template 行 19 | 需要提供业务文案或图标内容时设置。 |
labelSpacing | string | number | '' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95 | 需要提供业务文案或图标内容时设置。 |
itemAlign | string | 'center' | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 73 | 需要覆盖组件默认业务值时设置。 |
gap | string | number | '' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95、template 行 7 | 需要覆盖组件默认业务值时设置。 |
itemPadding | string | number | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 74 | 需要覆盖组件默认业务值时设置。 |
itemRadius | string | number | '' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 74、script 行 113 | 需要调整布局或视觉表现时设置。 |
activeInset | string | number | '' | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 82、script 行 111 | 需要覆盖组件默认业务值时设置。 |
activeRadius | string | number | '' | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 83、script 行 113 | 需要调整布局或视觉表现时设置。 |
stackPaddingTop | string | number | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 78 | 需要覆盖组件默认业务值时设置。 |
stackPaddingBottom | string | number | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 79 | 需要覆盖组件默认业务值时设置。 |
iconWrapMinHeight | string | number | '' | 设置对应区域高度;消费位置:script 行 89 | 需要调整布局或视觉表现时设置。 |
activeItemBackground | string | '' | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 75 | 需要覆盖组件默认业务值时设置。 |
inactiveItemBackground | string | '' | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 75 | 需要覆盖组件默认业务值时设置。 |
showIndicator | boolean | false | 开关对应显示或交互行为;消费位置:script 行 81、template 行 9 | 需要控制显示、可用性或交互状态时设置。 |
indicatorStyle | string | 'pill' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 81、script 行 109、script 行 119、script 行 120 | 需要调整布局或视觉表现时设置。 |
indicatorColor | string | '' | 设置对应区域的颜色;消费位置:script 行 114、script 行 121 | 需要调整布局或视觉表现时设置。 |
indicatorWidth | string | number | '' | 设置对应区域宽度;消费位置:script 行 119 | 需要调整布局或视觉表现时设置。 |
indicatorHeight | string | number | '' | 设置对应区域高度;消费位置:script 行 120 | 需要调整布局或视觉表现时设置。 |
indicatorPosition | string | 'auto' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 116 | 需要覆盖组件默认业务值时设置。 |
indicatorOffset | string | number | '' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 117、script 行 118 | 需要覆盖组件默认业务值时设置。 |
itemClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 6 | 需要调整布局或视觉表现时设置。 |
itemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 86 | 需要调整布局或视觉表现时设置。 |
activeItemClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 6 | 需要调整布局或视觉表现时设置。 |
activeItemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 86 | 需要调整布局或视觉表现时设置。 |
labelClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
labelStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 106 | 需要调整布局或视觉表现时设置。 |
activeLabelClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
activeLabelStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 106 | 需要调整布局或视觉表现时设置。 |
iconWrapStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 89 | 需要调整布局或视觉表现时设置。 |
activeIconWrapStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 89 | 需要调整布局或视觉表现时设置。 |
customClass | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | any | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | select 内触发(script 行 134);参数表达式:index;前置 guard:item.disabled、props.route && item.url | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | select 内触发(script 行 135);参数表达式:index;前置 guard:item.disabled、props.route && item.url | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | select 内触发(script 行 136);参数表达式:index;前置 guard:item.disabled、props.route && item.url | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | select 内触发(script 行 137);参数表达式:{ index, item };前置 guard:item.disabled、props.route && item.url | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
click-item | select 内触发(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。