Taroify

Icon 图标

介绍

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

引入

import { ChatOutlined } from "@taroify/icons"

代码演示

基础用法

通过导入的方式引用需要使用的图标，Taroify 内置了一套 Vant 图标库（见右侧示例），可以直接复制对应的名称来使用。

<ChatOutlined />

徽标提示

与 Badge 组件组合使用，会在图标右上角展示相应的徽标。

<Badge dot>
  <ChatOutlined />
</Badge>

<Badge content="9">
  <ChatOutlined />
</Badge>

<Badge content={100} max={99}>
  <ChatOutlined />
</Badge>

图标颜色

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

<CartOutlined style={{ color: "#1989fa" }} />
<FireOutlined style={{ color: "#ee0a24" }} />

图标大小

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

<!-- 不指定单位，默认使用 px -->
<ChatOutlined size="40" />
<!-- 指定使用 rem 单位 -->
<ChatOutlined size="3rem" />

自定义图标

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

/* 引入第三方或自定义的字体图标样式 */
@font-face {
  font-family: 'my-icon';
  src: url('./my-icon.ttf') format('truetype');
}

.my-icon {
  font-family: 'my-icon';
}

.my-icon-extra::before {
  content: '\e626';
}

import { Icon } from "@taroify/icons"
<!-- 通过 classPrefix 指定类名为 my-icon -->
<Icon classPrefix="my-icon" name="extra" />

API

Props

参数	说明	类型	默认值
color	图标颜色	string	`inherit`
size	图标大小，如 `20px` `2em`，默认单位为 `px`	number \| string	`inherit`
classPrefix	类名前缀，用于使用自定义图标	string	`van-icon`

Events

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