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

基础组件

@halo-dev/components 是 Halo 官方维护的基础组件库,Halo Console 和用户中心的界面均由这套组件构建。在插件中使用它可以获得与 Halo 一致的外观、交互和暗色模式适配。

本文档基于 @halo-dev/components 2.27.0。

安装

pnpm install @halo-dev/components

在 Vue 组件中按需引入:

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

<template>
  <VButton type="primary">Hello</VButton>
</template>
Tip

插件运行在 Halo Console 中时,组件库的样式已由 Console 统一加载,无需额外引入。如果需要在独立的 Vue 应用中预览或调试组件,可以手动引入:

import "@halo-dev/components/dist/style.css";

组件列表

通用

组件说明
按钮 VButton触发操作,支持类型、尺寸、加载状态
间距 VSpace控制子元素之间的间距
卡片 VCard带标题、操作和页脚的内容容器
描述列表 VDescription以键值对形式展示详情
页头 VPageHeader页面标题与操作区域
标签 VTag状态或分类标记
状态点 VStatusDot表示运行状态的小圆点
头像 VAvatar用户或应用头像,支持头像组
空状态 VEmpty无数据时的占位提示
加载中 VLoading加载动画
提示 VAlert页面内提示信息
开关 VSwitch开关选择器

导航与布局

组件说明
选项卡 VTabs在同一区域切换不同内容
菜单 VMenu多级垂直菜单
分页 VPagination列表分页与每页条数选择
下拉菜单 VDropdown悬浮展开的操作菜单

反馈

组件说明
弹窗 VModal模态对话框
确认对话框 Dialog函数式调用的确认对话框
轻提示 Toast页面顶部的临时消息
文字提示 Tooltip悬停提示,支持指令与组件两种用法

数据展示

组件说明
实体 VEntity列表中的一行数据

其他

组件说明
图标 IconsHalo 内置的图标组件

业务组件(如 UppyUpload、SearchInput 等)已在 Console 中全局注册,可直接使用,文档请参阅业务组件。

基础组件