Vant4 Sidebar 側(cè)邊導(dǎo)航

2023-02-16 17:56 更新

介紹

垂直展示的導(dǎo)航欄,用于在不同的內(nèi)容區(qū)域之間進(jìn)行切換。

引入

通過(guò)以下方式來(lái)全局注冊(cè)組件,更多注冊(cè)方式請(qǐng)參考組件注冊(cè)。

import { createApp } from 'vue';
import { Sidebar, SidebarItem } from 'vant';

const app = createApp();
app.use(Sidebar);
app.use(SidebarItem);

代碼演示

基礎(chǔ)用法

通過(guò) ?v-model? 綁定當(dāng)前選中項(xiàng)的索引。

<van-sidebar v-model="active">
  <van-sidebar-item title="標(biāo)簽名稱" />
  <van-sidebar-item title="標(biāo)簽名稱" />
  <van-sidebar-item title="標(biāo)簽名稱" />
</van-sidebar>
import { ref } from 'vue';

export default {
  setup() {
    const active = ref(0);
    return { active };
  },
};

徽標(biāo)提示

設(shè)置 ?dot? 屬性后,會(huì)在右上角展示一個(gè)小紅點(diǎn);設(shè)置 ?badge? 屬性后,會(huì)在右上角展示相應(yīng)的徽標(biāo)。

<van-sidebar v-model="active">
  <van-sidebar-item title="標(biāo)簽名稱" dot />
  <van-sidebar-item title="標(biāo)簽名稱" badge="5" />
  <van-sidebar-item title="標(biāo)簽名稱" />
</van-sidebar>

禁用選項(xiàng)

通過(guò) ?disabled? 屬性禁用選項(xiàng)。

<van-sidebar v-model="active">
  <van-sidebar-item title="標(biāo)簽名稱" />
  <van-sidebar-item title="標(biāo)簽名稱" disabled />
  <van-sidebar-item title="標(biāo)簽名稱" />
</van-sidebar>

監(jiān)聽切換事件

設(shè)置 ?change? 方法來(lái)監(jiān)聽切換導(dǎo)航項(xiàng)時(shí)的事件。

<van-sidebar v-model="active" @change="onChange">
  <van-sidebar-item title="標(biāo)簽名 1" />
  <van-sidebar-item title="標(biāo)簽名 2" />
  <van-sidebar-item title="標(biāo)簽名 3" />
</van-sidebar>
import { ref } from 'vue';
import { showToast } from 'vant';

export default {
  setup() {
    const active = ref(0);
    const onChange = (index) => showToast(`標(biāo)簽名 ${index + 1}`);
    return {
      active,
      onChange,
    };
  },
};

API

Sidebar Props

參數(shù) 說(shuō)明 類型 默認(rèn)值
v-model 當(dāng)前導(dǎo)航項(xiàng)的索引 number | string 0

Sidebar Events

事件名 說(shuō)明 回調(diào)參數(shù)
change 切換導(dǎo)航項(xiàng)時(shí)觸發(fā) index: number

SidebarItem Props

參數(shù) 說(shuō)明 類型 默認(rèn)值
title 內(nèi)容 string ''
dot 是否顯示右上角小紅點(diǎn) boolean false
badge 圖標(biāo)右上角徽標(biāo)的內(nèi)容 number | string -
badge-props v3.2.8 自定義徽標(biāo)的屬性,傳入的對(duì)象會(huì)被透?jìng)鹘o Badge 組件的 props BadgeProps -
disabled 是否禁用該項(xiàng) boolean false
url 點(diǎn)擊后跳轉(zhuǎn)的鏈接地址 string -
to 點(diǎn)擊后跳轉(zhuǎn)的目標(biāo)路由對(duì)象,等同于 vue-router 的 to 屬性 string | object -
replace 是否在跳轉(zhuǎn)時(shí)替換當(dāng)前頁(yè)面歷史 boolean false

SidebarItem Events

事件名 說(shuō)明 回調(diào)參數(shù)
click 點(diǎn)擊時(shí)觸發(fā) index: number

SidebarItem Slots

Name Description
title 自定義標(biāo)題

類型定義

組件導(dǎo)出以下類型定義:

import type { SidebarProps, SidebarItemProps } from 'vant';

主題定制

樣式變量

組件提供了下列 CSS 變量,可用于自定義樣式,使用方法請(qǐng)參考 ConfigProvider 組件

名稱 默認(rèn)值 描述
--van-sidebar-width 80px -
--van-sidebar-font-size var(--van-font-size-md) -
--van-sidebar-line-height var(--van-line-height-md) -
--van-sidebar-text-color var(--van-text-color) -
--van-sidebar-disabled-text-color var(--van-text-color-3) -
--van-sidebar-padding 20px var(--van-padding-sm) -
--van-sidebar-active-color var(--van-active-color) -
--van-sidebar-background var(--van-background) -
--van-sidebar-selected-font-weight var(--van-font-bold) -
--van-sidebar-selected-text-color var(--van-text-color) -
--van-sidebar-selected-border-width 4px -
--van-sidebar-selected-border-height 16px -
--van-sidebar-selected-border-color var(--van-primary-color) -
--van-sidebar-selected-background var(--van-background-2) -


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)