Tantalum UI

Appearance

Return to top
On this page

SideTab 侧边标签栏

vue
<template>
  <ta-group title="基础用法">
    <div class="exp-sideTab-box">
      <ta-side-tab ref="sideTabRef" :options="tabList" v-model="activeValue"></ta-side-tab>
    </div>
  </ta-group>
  <ta-group title="Mix">
    <div class="exp-sideTab-box">
      <ta-side-tab :options="mixTabList"></ta-side-tab>
    </div>
  </ta-group>
</template>

<script lang="ts">
import { defineComponent, ref } from 'vue'
import { mixTabList, tabList } from '../Tab/data'

export default defineComponent({
  name: 'ExpSideTab',
  setup() {
    const sideTabRef = ref()

    return {
      sideTabRef,
      activeValue: ref(1),
      mixTabList,
      tabList
    }
  }
})
</script>

Import

js
import { TaSideTab } from 'tantalum-ui-mobile'

具体的引入方式可以参考引入组件。

Import Type

组件导出的类型定义：

ts
import type {
  SideTabOnChange,
  SideTabOptions,
  SideTabOption,
  BadgeOption,
  SideBarRef
} from 'tantalum-ui-mobile'

Props

属性类型默认值必填说明
v-modelstring | number否当前激活项的 value 值
optionsSideTabOptions[]是tab 数据集
colorstring否自定义默认态字体和图标颜色
active-colorstring否自定义激活态的字体和图标颜色

SideTabOptions

ts
type SideTabOption = {
  label: string
  value: number | string
  icon?: IconData
  activeIcon?: IconData
  badge?: BadgeOption
  subLabel?: string
}

type SideTabOptions = (number | string | SideTabOption)[]
key类型默认值必填说明
valuestring | number是唯一值（v-model 使用）
labelstring是标签名
iconstring | Component否设置图标，使用 Icon 组件，也支持图像 URL
activeIconstring | Component否设置激活态图标，也支持图像 URL，没有设置则沿用 icon 属性
badgeBadgeOption否徽标，使用 Badge 组件
js
const options = [
  {
    value: 1,
    label: '首页',
    icon: 'HomeOutlined',
    badge: '热'
  },
  {
    value: 2,
    label: '搜索',
    icon: 'SearchOutlined',
    badge: {
      dot: true,
      content: 1
    }
  }
]

也可以直接设置为 string[] 或 number[]，如：

js
const options = ['aaa', 'bbb', 'ccc']

将被转为：

js
const options = [
  {
    value: 'aaa',
    label: 'aaa'
  },
  {
    value: 'bbb',
    label: 'bbb'
  }
  {
    value: 'ccc',
    label: 'ccc'
  }
]

注：注意数组项要保持唯一性。

BadgeOption

ts
type BadgeOption =
  | number
  | string
  | Partial<{
      color: string
      content: string | number
      offset: number[]
      animated: boolean
      dot: boolean
      maxCount: number
      showZero: boolean
    }>

参数主要是基于 Badge 组件的 props，如果传入是 number 或者 string 则设置直接设置 content 属性。

Events

事件描述回调函数参数TypeScript 函数
change点击切换 tab 时触发( value：string | number, index: number )SideTabOnChange

change 的回调参数

参数类型描述
valuestring | number当前激活项的 value 值
indexnumber当前激活项的索引值

Methods

ts
interface SideBarRef {
  switchTo: (value: string | number) => void
  switchToIndex: (index: number) => void
}
方法名说明
switchTo切换到指定 value 的 Tab
switchToIndex切换到指定索引的 Tab