Icon 图标

介绍

基于字体的图标集,可以通过 Icon 组件使用,也可以在其他组件中通过 icon 属性引用。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Icon } from 'vant';
  3. const app = createApp();
  4. app.use(Icon);

代码演示

基础用法

通过 name 属性来指定需要使用的图标,Vant 内置了一套图标库(见右侧示例),可以直接传入对应的名称来使用。

  1. <van-icon name="chat-o" />

使用图片 URL

你也可以直接在 name 属性中传入一个图片 URL 来作为图标。

  1. <van-icon name="https://fastly.jsdelivr.net/npm/@vant/assets/icon-demo.png" />

徽标提示

设置 dot 属性后,会在图标右上角展示一个小红点;设置 badge 属性后,会在图标右上角展示相应的徽标。

  1. <van-icon name="chat-o" dot />
  2. <van-icon name="chat-o" badge="9" />
  3. <van-icon name="chat-o" badge="99+" />

图标颜色

通过 color 属性来设置图标的颜色。

  1. <van-icon name="cart-o" color="#1989fa" />
  2. <van-icon name="fire-o" color="#ee0a24" />

图标大小

通过 size 属性来设置图标的尺寸大小,可以指定任意 CSS 单位。

  1. <!-- 不指定单位,默认使用 px -->
  2. <van-icon name="chat-o" size="40" />
  3. <!-- 指定使用 rem 单位 -->
  4. <van-icon name="chat-o" size="3rem" />

自定义图标

如果需要在现有 Icon 的基础上使用更多图标,可以引入第三方 iconfont 对应的字体文件和 CSS 文件,之后就可以在 Icon 组件中直接使用。

  1. /* 引入第三方或自定义的字体图标样式 */
  2. @font-face {
  3. font-family: 'my-icon';
  4. src: url('./my-icon.ttf') format('truetype');
  5. }
  6. .my-icon {
  7. font-family: 'my-icon';
  8. }
  9. .my-icon-extra::before {
  10. content: '\e626';
  11. }
  1. <!-- 通过 class-prefix 指定类名为 my-icon -->
  2. <van-icon class-prefix="my-icon" name="extra" />

API

Props

参数说明类型默认值
name图标名称或图片链接string-
dot是否显示图标右上角小红点booleanfalse
badge图标右上角徽标的内容number | string-
badge-props v3.2.8自定义徽标的属性,传入的对象会被透传给 Badge 组件的 propsBadgeProps-
color图标颜色stringinherit
size图标大小,如 20px 2em,默认单位为 pxnumber | stringinherit
class-prefix类名前缀,用于使用自定义图标stringvan-icon
tag根节点对应的 HTML 标签名stringi

Events

事件名说明回调参数
click点击图标时触发event: MouseEvent

类型定义

组件导出以下类型定义:

  1. import type { IconProps } from 'vant';

Icon 图标 - 图1