zhsw_wechat/miniprogram_npm/tdesign-miniprogram/side-bar/README.md

---

title: SideBar 侧边栏 description: 用于内容分类后的展示切换。 spline: navigation

isComponent: true

该组件于 0.25.0 版本上线，请留意版本。

引入

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

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

代码演示

在开发者工具中预览效果

Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"

锚点用法

{{ base }}

切页用法

{{ switch }}

带图标侧边导航

{{ with-icon }}

自定义样式

{{ custom }}

API

SideBar Props

名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- style | Object | - | 样式 | N custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N value | String / Number | - | 选项值 | N default-value | String / Number | undefined | 选项值。非受控属性 | N

SideBar Events

名称 | 参数 | 描述 -- | -- | -- change | (value: number \| string, label: string) | 选项值发生变化时触发 click | (value: number \| string, label: string) | 点击选项时触发

SideBarItem Props

名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- style | Object | - | 样式 | N custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N badge-props | Object | - | 透传至 Badge 组件。TS 类型：BadgeProps，Badge API Documents。详细类型定义 | N disabled | Boolean | false | 是否禁用 | N icon | String / Object | - | 图标，传对象则透传至 Icon | N label | String | - | 展示的标签 | N value | String / Number | - | 当前选项的值 | N

CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。 名称 | 默认值 | 描述 -- | -- | -- --td-side-bar-bg-color | @bg-color-secondarycontainer | - --td-side-bar-height | 100% | - --td-side-bar-width | 206rpx | - --td-side-bar-active-color | @brand-color | - --td-side-bar-bg-color | @bg-color-secondarycontainer | - --td-side-bar-border-radius | 18rpx | - --td-side-bar-color | @font-gray-1 | - --td-side-bar-disabled-color | @font-gray-4 | - --td-side-bar-font-size | 32rpx | - --td-side-bar-icon-size | 40rpx | - --td-side-bar-item-height | 112rpx | - --td-side-bar-item-line-height | 48rpx | -