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/dropdown.md.

VDropdown 下拉菜单

下拉菜单用于收纳一组次要操作,点击触发元素后展开。

组件库重新导出了 floating-vue 的 Dropdown 组件,并基于它提供了 Halo 风格的菜单项和分割线。

引入

import {
  VDropdown,
  VDropdownDivider,
  VDropdownItem,
} from "@halo-dev/components";

示例

基础用法

<script lang="ts" setup>
import { VButton, VDropdown, VDropdownItem, Toast } from "@halo-dev/components";

function handleSelect(action: string) {
  Toast.success(`选择了:${action}`);
}
</script>

<template>
  <VDropdown placement="bottom-start" :distance="6">
    <VButton>更多操作</VButton>
    <template #popper>
      <VDropdownItem @click="handleSelect('编辑')">编辑</VDropdownItem>
      <VDropdownItem @click="handleSelect('复制')">复制</VDropdownItem>
      <VDropdownItem @click="handleSelect('移动')">移动</VDropdownItem>
    </template>
  </VDropdown>
</template>

选中与禁用

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

<template>
  <VDropdown placement="bottom-start" :distance="6">
    <VButton>排序方式</VButton>
    <template #popper>
      <VDropdownItem selected>最近创建</VDropdownItem>
      <VDropdownItem>最近更新</VDropdownItem>
      <VDropdownItem disabled>访问量最多</VDropdownItem>
    </template>
  </VDropdown>
</template>

分割线与危险操作

<script lang="ts" setup>
import {
  VButton,
  VDropdown,
  VDropdownDivider,
  VDropdownItem,
} from "@halo-dev/components";
</script>

<template>
  <VDropdown placement="bottom-start" :distance="6">
    <VButton>操作</VButton>
    <template #popper>
      <VDropdownItem>查看详情</VDropdownItem>
      <VDropdownItem>导出</VDropdownItem>
      <VDropdownDivider />
      <VDropdownItem type="danger">删除</VDropdownItem>
    </template>
  </VDropdown>
</template>

带图标

<script lang="ts" setup>
import {
  IconDeleteBin,
  IconExternalLinkLine,
  IconSave,
  VButton,
  VDropdown,
  VDropdownItem,
} from "@halo-dev/components";
</script>

<template>
  <VDropdown placement="bottom-start" :distance="6">
    <VButton>操作</VButton>
    <template #popper>
      <VDropdownItem>
        <template #prefix-icon>
          <IconSave />
        </template>
        保存
      </VDropdownItem>
      <VDropdownItem>
        <template #prefix-icon>
          <IconExternalLinkLine />
        </template>
        在新窗口打开
      </VDropdownItem>
      <VDropdownItem type="danger">
        <template #prefix-icon>
          <IconDeleteBin />
        </template>
        删除
      </VDropdownItem>
    </template>
  </VDropdown>
</template>

VDropdown Props

VDropdown 的完整属性请参考 floating-vue 文档,常用属性如下:

属性类型默认值说明
placementstring"bottom"弹出位置,例如 top、bottom-start、right
distancenumber0弹出层与触发元素的距离
triggersstring[]["hover", "focus"]触发方式,可选 hover、click、focus
shownbooleanfalse是否显示弹出层,支持 v-model:shown
disabledbooleanfalse是否禁用
themestring"dropdown"弹出层主题

VDropdownItem Props

属性类型默认值说明
selectedbooleanfalse是否显示选中样式
disabledbooleanfalse是否禁用
type"default" | "danger""default"菜单项类型

Emits

组件事件参数说明
VDropdownItemclickMouseEvent点击菜单项时触发,disabled 时不会触发
VDropdownshow-弹出层显示时触发
VDropdownhide-弹出层隐藏时触发
VDropdownupdate:shownboolean弹出层显示状态变化时触发

Slots

组件插槽说明
VDropdowndefault触发元素
VDropdownpopper弹出层内容
VDropdownItemdefault菜单项内容
VDropdownItemprefix-icon菜单项左侧图标
VDropdownItemsuffix-icon菜单项右侧图标

指令

vClosePopper 可以在弹出层内的元素上使用,点击后关闭当前弹出层。

<VButton v-close-popper>点击后关闭</VButton>