city-casereport/miniprogram_npm/tdesign-miniprogram/tab-bar/README.md
2023-12-06 14:22:42 +08:00

3.6 KiB
Raw Blame History

title description spline isComponent
TabBar 标签栏 用于在不同功能模块之间进行快速切换,位于页面底部。 navigation true

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-tab-bar": "tdesign-miniprogram/tab-bar/tab-bar",
  "t-tab-bar-item": "tdesign-miniprogram/tab-bar-item/tab-bar-item"
}

代码演示

组件类型

纯文本标签栏

{{ text-only }}

图标加文字标签栏

{{ base }}

纯图标标签栏

{{ icon-only }}

双层级纯文本标签栏

{{ sub }}

组件样式

弱选中标签栏

{{ badge }}

悬浮胶囊标签栏

{{ round }}

自定义主题

{{ custom }}

API

TabBar Props

名称 类型 默认值 说明 必传
bordered Boolean true 是否显示外边框 N
fixed Boolean true 是否固定在底部 N
safe-area-inset-bottom Boolean true 是否为 iPhoneX 留出底部安全距离 N
shape String normal 标签栏的形状。可选项normal/round N
split Boolean true 是否需要分割线 N
theme String normal 选项风格。可选项normal/tag N
value String / Number / Array null 当前选中标签的索引。TS 类型:string | number | Array<string | number> N
default-value String / Number / Array undefined 当前选中标签的索引。非受控属性。TS 类型:string | number | Array<string | number> N

TabBar Events

名称 参数 描述
change (value: string | number) 选中标签切换时触发

TabBar 外部样式类

类名 说明
t-class 根节点样式类

TabBarItem Props

名称 类型 默认值 说明 必传
badge-props Object - 图标右上角提示信息。TS 类型:BadgePropsBadge API Documents详细类型定义 N
icon String / Object / Slot - 图标名称。传入对象时透传至 Icon 组件 N
sub-tab-bar Array - 二级菜单。TS 类型:SubTabBarItem[] interface SubTabBarItem { value: string; label: string }详细类型定义 N
value String / Number - 标识符 N

CSS 变量

组件提供了下列 CSS 变量,可用于自定义样式。

名称 默认值 描述
--td-tab-bar-active-bg @brand-color-light -
--td-tab-bar-active-color @brand-color -
--td-tab-bar-bg-color @bg-color-container -
--td-tab-bar-border-color @border-color -
--td-tab-bar-color @font-gray-1 -
--td-tab-bar-height 80rpx -
--td-tab-bar-hover-bg-color rgba(0, 0, 0, 0.05) -
--td-tab-bar-spread-border-color @border-color -
--td-tab-bar-spread-shadow @shadow-3 -
--td-tab-bar-border-color @border-color -
--td-tab-bar-round-shadow @shadow-3 -