React優雅的封裝SvgIcon元件範例

2023-02-24 06:00:31

React如何優雅的封裝SvgIcon元件

相信使用過vue的夥伴們，或多或少都接觸或使用過vue-element-admin，其中許多封裝都不禁讓人拍案叫絕，因為本人之前是vue入門前端的，所以對vue-element-admin許多封裝印象深刻，現在從vue轉react之後，一直想把vue-element-admin裡面的封裝元件復刻到react當中使用，這次是SvgIcon元件的react封裝版本；

第一步：安裝svg-sprite-loader

npm 安裝

npm i svg-sprite-loader -D

yarn 安裝

yarn add svg-sprite-loader -D

第二步：設定webpack

      {
        test: /.svg$/,
        loader: "svg-sprite-loader",
        include: path.resolve(__dirname, "../src/icons"), 
        options: {
          symbolId: "icon-[name]" 
        }
      },
      {
        test: /.(eot|woff2?|ttf|svg)$/,
        exclude: path.resolve(__dirname, "../src/icons"), // 不處理 svg型別檔案
        use: [
          {
            loader: "url-loader",
            options: {
              name: "[name]-[hash:5].min.[ext]",
              limit: 10000,
              outputPath: "font",
              publicPath: "font"
            }
          }
        ]
      },

第三步：建立icons/svg資料夾，並且載入所有svg檔案

index.ts中方法

const requireAll = (requireContext: __WebpackModuleApi.RequireContext) =>
  requireContext.keys().map(requireContext)
const req = require.context('./svg', false, /.svg$/)
requireAll(req)
export {} // 預設到處，ts如若不匯出，會警告

第四步：建立 SvgIcon 元件

import React from 'react'
import PropTypes from 'prop-types'
import './index.scss'
const SvgIcon = (props: { iconClass: string; svgClass: string; fill: string ;click: MouseEventHandler<HTMLElement>}) => {
  const { iconClass, fill, svgClass,click } = props
  return (
    <i aria-hidden="true" onClick={click}>
      <svg className={`svg-class ${svgClass}`}>
        <use xlinkHref={'#icon-' + iconClass} fill={fill} />
      </svg>
    </i>
  )
}
SvgIcon.propTypes = {
  // svg名字
  iconClass: PropTypes.string.isRequired,
  // 自定義類名
  svgClass: PropTypes.string,
    //自定義方法
  click: PropTypes.func,
  // 填充顏色
  fill: PropTypes.string,
}
SvgIcon.defaultProps = {
  fill: 'currentColor',
  svgClass: '',
  click: () => {},
}
export default SvgIcon

第五步：在元件中使用 SvgIcon

import React from 'react'
import SvgIcon from '@/components/SvgIcon'
const Index = () => {
  return (
    <div>
      <SvgIcon iconClass="礦泉水" />
    </div>
  )
}
export default Index

最終效果：