小程序开发
uniapp多端开发
扩展组件

uni-icons 图标

# uni-icons 图标

组件名：uni-icons（已支持 uni-app x）

代码块： uIcons

用于展示 icon 图标。

# 介绍

# 基本用法

<uni-icons type="contact" size="30"></uni-icons>

# 图标示例

点击复制图标类型

# API

# Icons Props

属性名	类型	默认值	说明
size	Number	24	图标大小
type	String	-	图标图案，参考示例
color	String	-	图标颜色
customPrefix`[即将废弃]`	String	-	自定义图标
fontFamily	String	-	自定义图标 `2.0.0+支持`

# Icons Events

事件名	说明	返回值
@click	点击 Icon 触发事件	-

# 通过 fontFamily 自定义图标

引入字体图标
页面 style 中定义 font-family 属性，并正确引入字体

@font-face {
	font-family: CustomFont;
	src: url('./iconfont.ttf');
}

1
2
3
4

组件声明 fontFamily 属性，值为步骤2 的 font-family ,此时组件的 type 属性将不生效
组件内需要使用字体的 unicode 码作为图标显示内容

<uni-icons fontFamily="CustomFont" :size="26">{{'\uebc6'}}</uni-icons>

1
2

方便使用扩展，推荐将 unicode 与显示内容做一个map映射

<template>
<view class="icon-content">
	<view v-for="(item,index) in customIcons" :key="index">
		<uni-icons fontFamily="CustomFont" >{{item.unicode}}</uni-icons>
		<text>{{item.name}}</text>
	</view>
</view>
</template>
<script>
export default {
	data() {
		return {
			icons: [],
			customIcons: [
				{
					name: "home",
					unicode: "\ue601",
				},
				{
					name: "my",
					unicode: "\ue6ba",
				},
				{
					name: "back",
					unicode: "\ue634",
				}
			]
		}
	},
	created() {},
}
</script>
<style>
@font-face {
	font-family: CustomFont;
	src: url('./iconfont.ttf');
}
</style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# 通过 customPrefix 自定义图标（即将废弃）

注意

nvue 页面暂时不支持自定义图标，如需在 nvue 中使用，请自行引入字体文件

uni-icons 已经收录了日常开发中常用的图标，但是因为体积问题，不可能一直无限添加新图标，所以uni-icons 也提供了扩展的方法。

使用 custom-prefix 和 type 属性自定义图标

<uni-icons custom-prefix="custom-icon" type="icon-youxi" size="30"></uni-icons>

# 获取图标

以下所有说明都是基于阿里图标库 (opens new window)进行扩展，其他图标库同理，明白原理即可方便扩展

访问阿里图标库 (opens new window)，搜索图标并加入购物车：
点击页面右上角购物车图标，点击添加至项目，如没有项目，需要点击下图第二步的图标添加一个项目目录，如已经有项目则可以略过第二步，选择项目后点击确定：

添加至项目

确定后进入项目，点击项目设置，对图标库进行一些设置：
项目名称和项目描述根据自己需求填写， fontClass 是图标的前缀，需要传入组件type属性，fontFamily 是图标集名称，需要传入组件custom-prefix 属性，字体格式可以只勾选 ttf:
点击保存后，可以下载图库库到本地：
下载解压后，需要用到的文件暂时有两个 iconfont.css、iconfont.ttf:
将 iconfont.ttf、iconfont.css 放到项目根目录 static 下。

打开 iconfont.css ,修改 @font-face 如下,注意 src 字体文件的引用路径是否正确：

@font-face {
	font-family: "iconfont"; 
	src: url('/static/iconfont.ttf') format('truetype');
}

.iconfont {
  font-family: "iconfont" !important;
  font-size: 16px;
}

.icon-search:before {
  content: "\e65c";
}

1
2
3
4
5
6
7
8
9
10
11
12
13

通过上述操作，现在就获得一个可以自定义的图标库，

# 在 vue 页面使用自定义图标

在项目根目录的 App.vue 中，引入上述的 iconfont.css，注意自己存放的路径，且通过 @import 引入的外部样式，需要写在 style 标签有效内容中的最前面

<!-- App.vue -->
<style>
@import "@/static/iconfont.css";
</style>