Skip to content

Commit 2ef6dbe

Browse files
committed
docs: add icons
1 parent 50d2922 commit 2ef6dbe

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

.vitepress/config.ts

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const Guides: DefaultTheme.NavItemWithLink[] = [
66

77
const vue3VantMobile: DefaultTheme.NavItemWithLink[] = [
88
{ text: '介绍', link: '/vue3-vant-mobile/' },
9+
{ text: '图标', link: '/vue3-vant-mobile/icons' },
910
]
1011

1112
const vue3VarletMobile: DefaultTheme.NavItemWithLink[] = [

vue3-vant-mobile/icons.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: 图标
3+
description: 如何使用图标
4+
outline: deep
5+
---
6+
7+
# :tada: 图标
8+
9+
图标是文字的隐喻,可以实现视觉引导和功能划分。
10+
11+
## 内置图标
12+
13+
内置图标是模板预先提供好的,开发者可以直接使用。模板默认以 [Vant](https://github.com/youzan/vant) 作为移动端组件库,它提供了基于字体的图标集 [Icon](https://vant-ui.github.io/vant/#/zh-CN/icon) 组件。
14+
15+
我们可以像下面一样使用,非常地简单。
16+
17+
```vue
18+
<van-icon name="chat-o" />
19+
```
20+
21+
大部分时候,内置的图标无法满足我们的需求场景,这就需要引入外部图标集。
22+
23+
## 外部图标
24+
25+
我们推荐 [iconify](https://iconify.design/)。它是统一的图标框架,超过 `150` 多个图标集,和 `200,000` 个开源矢量图标,并且会定期更新图标。您可以在 [iconify](https://icon-sets.iconify.design/) 或者 [icones](https://icones.js.org/) 中看到所有的图标集。
26+
27+
使用 `iconify` 有多种方式,我们模板使用 [CSS icon](https://antfu.me/posts/icons-in-pure-css) 方案,此方案由 `@unocss/preset-icons` 提供支持,可以很好的和 [Unocss](https://unocss.dev/) 配合使用。
28+
29+
### 安装和使用
30+
31+
假设我们用到 [carbon](https://icones.js.org/collection/carbon) 图标集,首先安装它。
32+
33+
::: code-group
34+
35+
```bash [pnpm]
36+
pnpm add -D @iconify-json/carbon
37+
```
38+
39+
:::
40+
41+
安装完成后,还应该将其引入到 [exclude](https://github.com/easy-temps/vue3-vant-mobile/blob/main/build/vite/optimize.ts) 配置里。
42+
43+
::: info
44+
45+
所有以 `@iconify-icons/` 开头引入的的本地图标模块,都应该加入到下面的 `exclude` 里,因为平台推荐的使用方式是按需引入,不需要预构建,直接让浏览器加载。
46+
47+
:::
48+
49+
然后像下面这样使用它。
50+
51+
```vue
52+
<!-- Sun in light mode, Moon in dark mode, from Carbon -->
53+
<button class="i-carbon-sun dark:i-carbon-moon" />
54+
```
55+
56+
::: tip
57+
58+
请遵循以下约定使用图标:
59+
60+
- `<prefix><collection>-<icon>`
61+
- `<prefix><collection>:<icon>`
62+
63+
:::
64+
65+
### 图标插件
66+
67+
VSCode 用户,推荐安装 [antfu.iconify](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) 插件。它可以高亮图标的显示和自动完成。

0 commit comments

Comments
 (0)