图标
图标是内联的 SVG,颜色跟随文字颜色(currentColor),大小由 NsIcon 的 size 控制:可选 xs 12px、sm 14px、md 16px、lg 18px、xl 24px,默认 md。尺寸是固定的像素值,不随父元素的字号变化。组件的详细参数见 Icon 图标。
基本用法
vue
<script setup lang="ts">
import { NsIcon } from '@ns/ui'
</script>
<template>
<NsIcon name="search" />
<NsIcon name="success" color="#52c41a" size="lg" />
<NsIcon name="loading" spin />
</template>
很多组件有 icon 这类属性,传的也是图标名,例如 <NsButton icon="plus">新增</NsButton>。
图标清单
name 只能用下面这些名字。写了清单以外的名字不会报错,但图标位置是一块 1em×1em(默认 16px)的空白,会把旁边的文字推开。
| 分组 | 图标名 |
|---|---|
| 方向和导航 | home menu apps top arrow-up arrow-down arrow-left arrow-right chevron-up chevron-down chevron-left chevron-right double-left double-right caret-up caret-down caret-left caret-right more-horizontal more-vertical |
| 操作 | close check plus minus edit trash refresh copy save share link upload download filter sort drag lock eye eye-off zoom-in zoom-out rotate-left rotate-right fullscreen |
| 状态 | success warning error info help loading star star-half heart clock calendar |
| 用户和通用 | user users setting search bell phone location mail |
| 文件 | file folder image table |
用自己的图标
NsIcon 的默认插槽可以放任意 SVG,尺寸、颜色、旋转这些属性照样生效:
vue
<template>
<NsIcon name="custom" size="lg" color="#1890ff">
<svg viewBox="0 0 24 24" fill="currentColor">
<path d="M12 2 2 7l10 5 10-5-10-5z" />
</svg>
</NsIcon>
</template>
SVG 要带 viewBox,填充色写 currentColor,这样才能跟着 color 属性变色。
传了插槽时插槽内容优先,不再渲染 name 对应的内置图标。name 仍然必填,并且会作为 aria-label 被读屏软件读出来,上面的 name="custom" 会被读成 “custom”,自定义图标最好给一个有意义的名字。
直接使用图标数据
@ns/icons 导出了图标的原始数据,需要自己渲染时可以用:
ts
import { icons, iconList, iconGroups } from '@ns/icons'
icons['arrow-up'] // { name: 'arrow-up', svg: '<svg ...>...</svg>' }
iconList // 全部图标的数组,适合做图标选择器
iconGroups.navigation // 按分组取:navigation、action、status、user、file
每个图标也可以按驼峰名单独导入:import { arrowUp, chevronLeft } from '@ns/icons'。