Element Plus 组件库实现:4. Icon

前言

在数字化时代,图标(icon)已经成为我们日常生活中不可或缺的一部分。无论是手机APP、网页界面还是各类软件应用,图标都以其简洁、直观的特性,帮助用户快速理解并操作界面。icon组件,对于提升用户体验和界面的整体美观度至关重要。本文将简单介绍icon组件的开发。

Fontawesome

icon组件是一个组件库不可或缺的存在,现阶段也有很多优秀的图标库,所以我们也没有必要去从0到1去开发一款新的组件库,这也不是本组件库的目的,所以本次Icon组件将借助 Font Awesome 进行二次开发。

安装

bash 复制代码
// 安装 svg core
npm i--save @fortawesome/fontawesome-svg-core
// 安装图标库
npm i --save @fontawesome/free-solid-svg-icons
// 安装基于 vue3 的包
npm i --save @fortawesome/vue-fontawesome@latest-3

使用

ts 复制代码
// main.ts
import './styles/index.css'
import { createApp } from 'vue'
import App from './App.vue'
// library 是 Font Awesome SVG 图标库的一个核心对象,用于管理和存储所有可用的图标
import { library } from '@fortawesome/fontawesome-svg-core'
//fas 是 Font Awesome 提供的一个集合,包含了所有 solid 风格的免费图标
import { fas } from '@fortawesome/free-solid-svg-icons'
// 将 fas 集合中的所有 solid 风格图标添加到 library 对象中,然后就可以使用这些图标了
library.add(fas)

createApp(App).mount('#app')

二次开发

属性:

ts 复制代码
export interface IconProps {
  // 这里仅展示自定义属性,省略其他Fontawesome自带属性
  type?: 'primary' | 'success' | 'warning' | 'danger' | 'info'
  color?: string
}

Icon.vue:

html 复制代码
<script setup lang="ts">
// 引入 FontAwesomeIcon 组件
import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
import type { IconProps } from './types'
// 引入要用到的omit方法,在lodash中
import { omit } from 'lodash-es'
import { computed } from 'vue';
defineOptions({
    name: 'YvIcon',
    // 禁止透传,手动将属性传递到 <font-awesome-icon />组件
    inheritAttrs: false
})
const props = defineProps<IconProps>()
// 这里使用omit方法将type和color属性过滤掉
// 因为 <font-awesome-icon /> 本身是没有这两个属性,所以最好过滤掉
// 这两个属性是要添加到 <font-awesome-icon />  的父元素
const filterProps = computed(() => omit(props, ['type', 'color']))
// 根据传递进来的属性确定图标的样式
const customStyles = computed(() => {
    return props.color ? { color: props.color } : {}
})
</script>

<template>
 <!-- 因为已经禁用了透传,所以这里要使用 $attrs 来接收非props的属性或者事件 -->
    <i class="yv-icon" :class="{ [`yv-icon--${type}`]: type }" :style="customStyles" v-bind="$attrs">
        <font-awesome-icon v-bind="filterProps" />
    </i>
</template>

总结

本文主要结合Fontawesome对Icon组件进行了二次开发,但是在开发过程中要注意以下几点:

  • 使用inheritAttrs: false 禁用透传,目的是手动将icon原本的属性进行手动绑定
  • 解决禁用透传以后一些默认属性失效的问题,比如新增class无法传递到Icon,那么这个时候就要使用$attrs来解决

以上就是对Icon组件的一个简单的二次封装,还是和以前一样,style等样式不再做详细赘述,感谢阅览,如有错误还请大佬评论区批评指正。

相关推荐
阿奇__3 分钟前
element 跨页选中,回显el-table选中数据
前端·vue.js·elementui
谢尔登4 分钟前
【React】SWR 和 React Query(TanStack Query)
前端·react.js·前端框架
断竿散人4 分钟前
专题一、HTML5基础教程-Viewport属性深入理解:移动端网页的魔法钥匙
前端
3Katrina5 分钟前
理解Promise:让异步编程更优雅
前端·javascript
星之金币6 分钟前
关于我用Cursor优化了一篇文章:30 分钟学会定制属于你的编程语言
前端·javascript
天外来物8 分钟前
实战分享:用CI/CD实现持续部署
前端·nginx·docker
moxiaoran57539 分钟前
Spring Cloud Gateway 动态路由实现方案
运维·服务器·前端
市民中心的蟋蟀9 分钟前
第十一章 这三个全局状态管理库之间的共性与差异 【上】
前端·javascript·react.js
vvilkim23 分钟前
Flutter 常用组件详解:Text、Button、Image、ListView 和 GridView
前端·flutter
vvilkim30 分钟前
Flutter 命名路由与参数传递完全指南
前端·flutter