For AI agents: the complete documentation index is available at https://docs.halo.run/llms.txt, the full documentation bundle is available at https://docs.halo.run/llms-full.txt, and this page is available as Markdown at https://docs.halo.run/developer-guide/plugin/api-reference/ui/base-components/menu.md.

VMenu 菜单

VMenu 用于构建垂直导航菜单,支持多级子菜单、图标和选中状态。

引入

import { VMenu, VMenuItem, VMenuLabel } from "@halo-dev/components";

示例

基础用法

<script lang="ts" setup>
import { ref } from "vue";
import { VMenu, VMenuItem } from "@halo-dev/components";

const activeId = ref("dashboard");
</script>

<template>
  <VMenu>
    <VMenuItem
      id="dashboard"
      title="概览"
      :active="activeId === 'dashboard'"
      @select="activeId = 'dashboard'"
    />
    <VMenuItem
      id="posts"
      title="文章"
      :active="activeId === 'posts'"
      @select="activeId = 'posts'"
    />
    <VMenuItem
      id="pages"
      title="页面"
      :active="activeId === 'pages'"
      @select="activeId = 'pages'"
    />
  </VMenu>
</template>

带图标

<script lang="ts" setup>
import {
  IconDashboard,
  IconPages,
  IconSettings,
  VMenu,
  VMenuItem,
} from "@halo-dev/components";
</script>

<template>
  <VMenu>
    <VMenuItem id="dashboard" title="概览" active>
      <template #icon>
        <IconDashboard />
      </template>
    </VMenuItem>
    <VMenuItem id="content" title="内容">
      <template #icon>
        <IconPages />
      </template>
    </VMenuItem>
    <VMenuItem id="settings" title="设置">
      <template #icon>
        <IconSettings />
      </template>
    </VMenuItem>
  </VMenu>
</template>

多级菜单

默认插槽中的 VMenuItem 会作为子菜单渲染。

<script lang="ts" setup>
import { VMenu, VMenuItem } from "@halo-dev/components";
</script>

<template>
  <VMenu :open-ids="['content']">
    <VMenuItem id="content" title="内容管理">
      <VMenuItem id="posts" title="文章" />
      <VMenuItem id="pages" title="页面" />
      <VMenuItem id="categories" title="分类" />
    </VMenuItem>
    <VMenuItem id="settings" title="设置" />
  </VMenu>
</template>

分组标签

<script lang="ts" setup>
import { VMenu, VMenuItem, VMenuLabel } from "@halo-dev/components";
</script>

<template>
  <VMenu>
    <VMenuLabel>内容</VMenuLabel>
    <VMenuItem id="posts" title="文章" />
    <VMenuItem id="pages" title="页面" />
    <VMenuLabel>系统</VMenuLabel>
    <VMenuItem id="settings" title="设置" />
  </VMenu>
</template>

VMenu Props

属性类型默认值说明
openIdsstring[]undefined默认展开的菜单项 ID 列表

VMenuItem Props

属性类型默认值说明
idstring""菜单项唯一标识
titlestring""菜单项文字
activebooleanfalse是否为选中状态

Emits

事件参数说明
selectstring点击菜单项时触发,参数为菜单项 id

Slots

组件插槽说明
VMenuItemdefault子菜单项
VMenuItemicon菜单项图标
VMenuLabeldefault分组标签内容