自定义组件 SvgIcon

自定义组件 SvgIcon

方案一

提取分散在各组件下的 SVG 到指定目录后,通过 webpack 提供的 include、exclude 分别使用 svg-sprite-loaderfile-loaderinclude: new RegExp(/^(icon--).+\.svg$/g), 正则匹配无效)

  1. 添加依赖包 yarn add svg-sprite-loader svgo-loader -D

  2. 修改 webpack.config.js 添加配置

{
    test: /\.svg$/,
    // test: /^(icon--).+\\.svg$/,
    include: [resolve('src/icons')], // 仅处理 `src/icons` 下的 svg 文件
    use: [
        {
            loader: 'svg-sprite-loader',
            options: {
                extract: true, // 提取文件
                // spriteFilename: 'icons.svg', // SVG 雪碧图名称(默认 sprite.svg)
                outputPath: 'static/assets/' // SVG 雪碧图输出目录
            }
        },
        {
            loader: 'svgo-loader',
            options: {
                // plugins: [
                //     {removeAttrs: {attrs: 'fill'}} // 移除 fill 属性
                // ]
            }
        }
    ]
}
...
plugins: [
    new SpriteLoaderPlugin({plainSprite: true}) // 添加以启用 svg-sprite-loader 插件
]
...
module: {
    rules: base.module.rules.concat([
        {
            test: /\.(svg|png|wav|gif|jpg)$/,
            // test: /^(?!icon--).*\\.(svg|png|wav|gif|jpg)$/, // x 2
            exclude: [resolve('src/icons')], // 添加以排除 `src/icons` 目录 x 2
            loader: 'file-loader',
            options: {
                outputPath: 'static/assets/'
            }
        }
    ])
},
  1. 添加 src/components/svg-icon/svg-icon.jsx 组件
import classNames from 'classnames';
import PropTypes from 'prop-types';
import React from 'react';

import styles from './svg-icon.css';

// 批量导入 `src/icons/*.svg` 文件
const requireAll = requireContext => requireContext.keys().map(requireContext);
// 查找并引入目录中的 svg 图标(false: 不递归子目录)
requireAll(require.context('../../icons', false, /\.svg$/));
// components 子目录中含有其他 svg 已通过 webpack.config.js 排除,无法递归查找
// requireAll(require.context('../../components', true, /^(icon--).*\\.svg$/));

const SvgIcon = props => {
    const {
        className,
        title,
        icon,
        onClick,
        ...componentProps
    } = props;
    return (
        <svg
            // xmlns="http://www.w3.org/2000/svg"
            // xmlnsXlink="http://www.w3.org/1999/xlink"
            className={classNames(styles.icon, className)}
            aria-hidden="true"
            title={title}
            onClick={onClick}
            {...componentProps}
        >
            {/* 通过形如 `/${outputPath}/${spriteFilename}` 指定 SVG 雪碧图资源文件路径 */}
            <use xlinkHref={`/static/assets/sprite.svg#icon--${icon}`} />
        </svg>
    );
};

SvgIcon.propTypes = {
    className: PropTypes.string,
    title: PropTypes.string,
    icon: PropTypes.string.isRequired,
    onClick: PropTypes.func
};

export default SvgIcon;
  1. 资源预加载 入口模板 index.ejs 添加 <link rel="preload" href="<%- htmlWebpackPlugin.options.sprite %>" as="image"> 标签

  2. 造型编辑声音编辑 左侧展示列表图标兼容 <img> 元素和 <Icon> 组件

    • 造型编辑:在 src/components/gui/gui.jsx 使用组件 src/containers/costume-tab.jsx 构造 costumeData 造型数据集,传递给 src/components/asset-panel/selector.jsx 组件的 props.items 后遍历子组件 src/components/sprite-selector-item/sprite-selector-item.jsx 显示 img 图片

      const costumeData = target.costumes ? target.costumes.map(costume => ({
          name: costume.name,
          asset: costume.asset,
          details: costume.size ? this.formatCostumeDetails(costume.size, costume.bitmapResolution) : null,
          dragPayload: costume
      })) : [];
      
    • 声音编辑:在 src/components/gui/gui.jsx 使用组件 src/containers/sound-tab.jsx 构造 sounds 声音数据集,传递给 src/components/asset-panel/selector.jsx 组件的 props.items 后遍历子组件 src/components/sprite-selector-item/sprite-selector-item.jsx 显示 Icon 图标

      // 声音数据集中有 `url` 属性,后面会用作区分资源的依据(亦可使用 造型数据集 中的 `asset` 属性)
      const sounds = sprite.sounds ? sprite.sounds.map(sound => ({
          url: isRtl ? 'sound-rtl' : 'sound',
          name: sound.name,
          details: (sound.sampleCount / sound.rate).toFixed(2),
          dragPayload: sound
      })) : [];
      
    • 修改子组件 src/components/sprite-selector-item/sprite-selector-item.jsx 添加 isAudio 属性标记资源类型,并根据类型使用 <img><Icon> 显示资源:

      {props.costumeURL && (
          <div className={styles.spriteImageOuter}>
              <div className={styles.spriteImageInner}>
                  {props.isAudio ? (
                      <Icon
                          className={classNames(styles.spriteImage, styles.spriteIcon)}
                          src={props.costumeURL}
                      />
                  ) : (
                      <img
                          className={styles.spriteImage}
                          draggable={false}
                          src={props.costumeURL}
                      />
                  )}
               </div>
          </div>
      )}
      ...
      SpriteSelectorItem.propTypes = {
          isAudio: PropTypes.bool,
          ...
      }
      
    • 在父组件 src/containers/sprite-selector-item.jsx 传递 isAudio (音频资源的 costumeURL 为空,this.props.costumeURL && truestringboolean)

      return (
          <SpriteSelectorItemComponent
              isAudio={costumeURL && true}
              costumeURL={this.getCostumeData()}
              ...
          />
      );
      

方案二:

直接修改 test 匹配规则(是否以 icon-- 开头)分别使用不同的 loader 处理。

{
  test: /^(icon--).+\\.svg$/`, // 以 `icon--` 开头的 svg 文件
  loader: 'svg-sprite-loader',
  options: { ... }
}
...
{
  test: /^(?!icon--).*\\.(svg|png|wav|gif|jpg)$/, // 非 `icon--`开头的 svg 文件
  loader: 'file-loader',
  options: { ... }
}

引入时递归查找指定目录下 icon-- 开头的 svg 文件: `

const requireAll = requireContext => requireContext.keys().map(requireContext);
requireAll(require.context('../../components', true, new RegExp(/^(icon--).*\\.svg$/)));

SVG 分散在各组件中时,需要大量修改源码,不建议使用!

参考:
SVG 图标在React项目中的优化
React 里使用 svg-sprite-loader
手摸手,带你优雅的使用 icon
How to make react svg use xlinkHref work

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,451评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,172评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,782评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,709评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,733评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,578评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,320评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,241评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,686评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,878评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,992评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,715评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,336评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,912评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,040评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,173评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,947评论 2 355

推荐阅读更多精彩内容