Skip to content

侧边导航

@astryxdesign/core v0.7.1 · SideNav

SideNav Props ​

名称类型默认值说明
labelstring当前语言的「侧边导航」导航地标的无障碍名称。
collapsibleboolean | SideNavCollapsiblefalse允许收成图标栏。对象可设置初始状态、内置按钮和快捷键。
isCollapsedboolean-受控收起状态,配合 v-model:is-collapsed。
resizableboolean | SideNavResizablefalse在结束边拖宽度。对象可设置初始宽度、最小和最大宽度,以及记住宽度的 autoSaveId。
handleRefHandleRef<SideNavHandle>-侧栏外面的按钮可以拿到收起、展开和切换。更常见的做法是两边共用 v-model:is-collapsed。

SideNav 事件 ​

名称说明
update:isCollapsed收起状态变化,用于 v-model:is-collapsed。
collapsedChange收起状态变化时触发。
widthChange拖拽改变宽度时触发,参数是像素宽度。

SideNav Slots ​

名称说明
default导航主体,通常放分组和导航项。
header顶部品牌区。
top品牌区下面的附加内容。
footer底部内容,位于收起按钮之上。
footerIcons和收起按钮同一行的图标。

SideNavSection Props ​

名称类型默认值说明
titlestring-分组标题。收起后仍留给读屏。
subtitlestring-标题下面的辅助文字。
isHeaderHiddenbooleanfalse视觉上隐藏标题,读屏仍能读到。

SideNavItem Props ​

名称类型默认值说明
labelstring-项的名称。
hrefstring-跳转地址。有下级时,点文字跳转,点箭头收起。
asNavLinkComponent'a'链接根组件。
iconClassstring-图标 CSS class。收起后没有图标的项不渲染。
isSelectedbooleanfalse当前页。
isDisabledbooleanfalse禁用。
collapsibleboolean | object-有下级时是否可收起。传 false 则下级一直展开。

SideNavItem Slots ​

名称说明
default下级项。
icon项前面的图标。
selectedIcon选中时替换默认图标。
end主控件末尾的内容,仍在链接或按钮里面。
actions和主控件并排的操作,例如图标按钮。不放进链接里面。侧栏收起后不渲染。

SideNavHeading Props ​

名称类型默认值说明
headingstring-产品或应用名称。
headingHrefstring-主标题链接。
superheadingstring-主标题上方的小字。
superheadingHrefstring-上方小字的链接。
subheadingstring-主标题下方的小字。
subheadingHrefstring-下方小字的链接。
logoLabelstring-标志单独成链接时的无障碍名称。不传则用 heading。
asNavLinkComponent'a'链接根组件。

SideNavHeading Slots ​

名称说明
icon标题前的标志。收起后只剩这一块。
end标题行末尾。
menu弹出菜单,通常放 NavHeadingMenu。作用域提供 close 和 focusRequest。

SideNavCollapseButton Props ​

在展开和收起的侧栏之间切换。放在 SideNav 里时从侧栏读折叠状态;放在外面时用 v-model:is-collapsed 或 collapsible 绑同一个状态。

名称类型默认值说明
labelstring-按钮文字。给了文字就渲染成「箭头 + 文字」的按钮;不给则只有箭头图标,无障碍名称用翻译好的「收起侧边栏 / 展开侧边栏」。
collapsibleSideNavControlledCollapsible-受控的 { isCollapsed, onCollapsedChange } 配置,给放在侧栏外面的按钮用。把同一个对象也交给 SideNav。它优先于 isCollapsed。
isCollapsedboolean-折叠状态,用于 v-model:is-collapsed。按钮不在侧栏里时用它和侧栏连到同一个状态。
size'sm' | 'md' | 'lg'在 SideNav 里是 sm,外面是 md按钮尺寸。按钮放在有尺寸的容器外面、又要和旁边对齐时指定。

SideNavCollapseButton 插槽 ​

名称说明
default自定义按钮图标插槽的内容,替换默认的箭头。看得见的文字仍然来自 label。