zebra-ui基于uniapp,跨多端组件库
  • 2.x
  • 中文
开发指南
介绍
快速上手
进阶用法
常见问题
更新日志
贡献指南
国际化
基础组件
Button 按钮
Cell 单元格
ConfigProvider 全局配置
Icon 图标
Image 图片
Layout 布局
Popup 弹出层
Style 内置样式
Transition 动画
Toast 轻提示
表单组件
Area 省市区选择
Calendar 日历
Cascader 级联选择
Checkbox 复选框
DatePicker 日期选择
Field 输入框
Form 表单
NumberKeyboard 数字键盘
PasswordInput 密码输入框
Picker 选择器
PickerGroup 选择器组
Radio 单选框
Rate 评分
Search 搜索
Slider 滑块
Signature 签名
Stepper 步进器
Switch 开关
TimePicker 时间选择
Uploader 文件上传
反馈组件
ActionSheet 动作面板
Barrage 弹幕
Dialog 弹出框
DropdownMenu 下拉菜单
FloatingPanel 浮动面板
FloatingBubble 浮动气泡
Loading 加载
Notify 消息通知
Overlay 遮罩层
PullRefresh 下拉刷新
ShareSheet 分享面板
SwipeCell 滑动单元格
展示组件
Badge 徽标
Circle 环形进度条
Collapse 折叠面板
CountDown 倒计时
Divider 分割线
Empty 空状态
Highlight 高亮文本
List 列表
NoticeBar 通知栏
Popover 气泡弹出框
Progress 进度条
RollingText 翻滚文本
Skeleton 骨架屏
Steps 步骤条
Sticky 粘性布局
Swipe 轮播
Tag 标签
TextEllipsis 文本省略
Watermark 水印
导航组件
Grid 宫格
NavBar 导航栏
Sidebar 侧边导航
Tab 标签页
Tabbar 标签栏
TreeSelect 分类选择

Sidebar 侧边导航

介绍

垂直展示的导航栏,用于在不同的内容区域之间进行切换。

代码演示

基础用法

通过 v-model 绑定当前选中项的索引。

<z-sidebar v-model="active">
  <z-sidebar-item title="标签名称" />
  <z-sidebar-item title="标签名称" />
  <z-sidebar-item title="标签名称" />
</z-sidebar>
import { ref } from 'vue';

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

禁用选项

通过 disabled 属性禁用选项。

<z-sidebar v-model="active">
  <z-sidebar-item title="标签名称" />
  <z-sidebar-item title="标签名称" disabled />
  <z-sidebar-item title="标签名称" />
</z-sidebar>

监听切换事件

设置 change 方法来监听切换导航项时的事件。

<z-sidebar v-model="active" @change="onChange">
  <z-sidebar-item title="标签名 1" />
  <z-sidebar-item title="标签名 2" />
  <z-sidebar-item title="标签名 3" />
</z-sidebar>
import { ref } from 'vue';
import { useToast } from '@/uni_modules/zebra-ui'
const toast = useToast()

export default {
  setup() {
    const active = ref(0);
    const onChange = (index: number) => toast.showToast(`标题${index + 1}`)
    return {
      active,
      onChange,
    };
  },
};

徽标提示

设置 dot 属性后,会在右上角展示一个小红点;设置 badge 属性后,会在右上角展示相应的徽标。

<z-sidebar v-model="active">
  <z-sidebar-item title="标签名称" dot />
  <z-sidebar-item title="标签名称" badge="5" />
  <z-sidebar-item title="标签名称" />
</z-sidebar>

API

Sidebar Props

参数说明类型默认值
v-model当前导航项的索引number | string0

Sidebar Events

事件名说明回调参数
change切换导航项时触发index: number

SidebarItem Props

参数说明类型默认值
title内容string''
dot是否显示右上角小红点booleanfalse
badge图标右上角徽标的内容number | string-
badge-props自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps-
disabled是否禁用该项booleanfalse

SidebarItem Events

事件名说明回调参数
click点击时触发index: number

SidebarItem Slots

NameDescription
title自定义标题

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。

名称默认值描述
--z-sidebar-width160rpx-
--z-sidebar-font-sizevar(--z-font-size-md)-
--z-sidebar-line-heightvar(--z-line-height-md)-
--z-sidebar-text-colorvar(--z-text-color)-
--z-sidebar-disabled-text-colorvar(--z-text-color-3)-
--z-sidebar-padding40rpx var(--z-padding-sm)-
--z-sidebar-active-colorvar(--z-active-color)-
--z-sidebar-backgroundvar(--z-background)-
--z-sidebar-selected-font-weightvar(--z-font-bold)-
--z-sidebar-selected-text-colorvar(--z-text-color)-
--z-sidebar-selected-border-width8rpx-
--z-sidebar-selected-border-height32rpx-
--z-sidebar-selected-border-colorvar(--z-primary-color)-
--z-sidebar-selected-backgroundvar(--z-background-2)-