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

图标 Icons

基础组件库内置了一组基于 Remix Icon 的图标组件,可以直接引入使用。图标会继承当前文字颜色和字体大小。

引入

import { IconAddCircle, IconDeleteBin } from "@halo-dev/components";

示例

基础用法

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

<template>
  <div class="flex items-center gap-4 text-xl text-gray-600">
    <IconAddCircle />
    <IconSearch />
    <IconDeleteBin />
  </div>
</template>

在按钮中使用

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

<template>
  <VButton type="primary">
    <template #icon>
      <IconAddCircle />
    </template>
    新建
  </VButton>
</template>

通过组件动态渲染

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

const icons = [
  { name: "概览", component: IconDashboard },
  { name: "内容", component: IconPages },
  { name: "用户", component: IconTeam },
  { name: "设置", component: IconSettings },
];
</script>

<template>
  <div class="grid grid-cols-2 gap-3">
    <div
      v-for="icon in icons"
      :key="icon.name"
      class="flex items-center gap-2 rounded-base bg-gray-50 px-3 py-2 text-sm text-gray-600"
    >
      <component :is="icon.component" class="text-lg" />
      {{ icon.name }}
    </div>
  </div>
</template>

图标清单

组件对应的 Remix Icon
IconAccountCircleLineri/account-circle-line
IconAddCircleri/add-circle-line
IconArrowDownCircleLineri/arrow-down-circle-line
IconArrowDownri/arrow-down-s-fill
IconArrowDownLineri/arrow-down-s-line
IconArrowLeftRightLineri/arrow-left-right-line
IconArrowLeftri/arrow-left-s-line
IconArrowRightri/arrow-right-s-line
IconArrowUpCircleLineri/arrow-up-circle-line
IconArrowUpDownLineri/arrow-up-down-line
IconArrowUpLineri/arrow-up-s-line
IconBookReadri/book-read-line
IconCalendarri/calendar-line
IconCharacterRecognitionri/character-recognition-line
IconCheckboxFillri/checkbox-circle-fill
IconCheckboxCircleri/checkbox-circle-line
IconClipboardLineri/clipboard-line
IconCloseCircleri/close-circle-line
IconCloseri/close-line
IconCodeBoxLineri/code-box-line
IconComputerri/computer-line
IconDashboardri/dashboard-3-line
IconDatabase2Lineri/database-2-line
IconDeleteBinri/delete-bin-2-line
IconMotionLineri/emotion-line
IconErrorWarningri/error-warning-line
IconExchangeri/exchange-line
IconExternalLinkLineri/external-link-line
IconEyeri/eye-line
IconEyeOffri/eye-off-line
IconFolderri/folder-2-line
IconForbidLineri/forbid-line
IconGitBranchri/git-branch-line
IconGitHubri/github-fill
IconGridri/grid-line
IconHistoryLineri/history-line
IconImageAddLineri/image-add-line
IconInformationri/information-line
IconLinkri/link
IconListSettingsri/list-settings-line
IconListri/list-unordered
IconLockPasswordLineri/lock-password-line
IconLogoutCircleRLineri/logout-circle-r-line
IconMagicri/magic-line
IconMessageri/message-3-line
IconMoreri/more-line
IconNotificationBadgeLineri/notification-badge-line
IconPagesri/pages-line
IconPaletteri/palette-line
IconRiPencilFillri/pencil-fill
IconPlugri/plug-2-line
IconRefreshLineri/refresh-line
IconReplyLineri/reply-line
IconRocketLineri/rocket-line
IconSaveri/save-line
IconSearchri/search-2-line
IconSendPlaneFillri/send-plane-fill
IconServerLineri/server-line
IconSettings3Lineri/settings-3-line
IconSettingsri/settings-4-line
IconShieldUserri/shield-user-line
IconPhoneri/smartphone-line
IconStopCircleri/stop-circle-line
IconTabletri/tablet-line
IconTeamri/team-fill
IconTerminalBoxLineri/terminal-box-line
IconThumbUpLineri/thumb-up-line
IconTimerLineri/timer-line
IconToolsFillri/tools-fill
IconRiUpload2Fillri/upload-2-fill
IconUploadri/upload-cloud-2-line
IconUserFollowri/user-follow-line
IconUserLineri/user-line
IconUserSettingsri/user-settings-line
IconWindowLineri/window-line
IconZoomInLineri/zoom-in-line
IconZoomOutLineri/zoom-out-line