React Inline SVG 使用教程

项目介绍

react-inline-svg 是一个用于在 React 应用中内联加载和显示 SVG 文件的库。它允许你通过简单的 API 调用来加载 SVG 文件，并提供了一些额外的功能，如缓存、自定义处理和样式控制。这个库非常适合需要在 React 项目中动态加载和操作 SVG 文件的开发者。

项目快速启动

安装

首先，你需要通过 npm 或 yarn 安装 react-inline-svg：

npm install react-inline-svg

或者

yarn add react-inline-svg

基本使用

在你的 React 组件中，你可以这样使用 react-inline-svg：

import React from 'react';
import InlineSVG from 'react-inlinesvg';

const MyComponent = () => {
  return (
    <div>
      <InlineSVG
        src="/path/to/my-icon.svg"
        onLoad={(src) => console.log('SVG loaded:', src)}
        onError={(error) => console.error('Error loading SVG:', error)}
      />
    </div>
  );
};

export default MyComponent;

高级功能

你还可以使用一些高级功能，如预加载和自定义处理：

import React from 'react';
import InlineSVG from 'react-inlinesvg';

const MyComponent = () => {
  return (
    <div>
      <InlineSVG
        src="/path/to/my-icon.svg"
        preload
        uniqueHash="my-unique-hash"
        uniquifyIDs
        beforeInjection={(svg) => {
          svg.classList.add('svg-class');
        }}
      />
    </div>
  );
};

export default MyComponent;

应用案例和最佳实践

动态加载 SVG

在需要根据用户操作动态加载不同 SVG 文件的场景中，react-inline-svg 非常有用。例如，在一个图标选择器中，你可以根据用户的选择动态加载相应的 SVG 图标：

import React, { useState } from 'react';
import InlineSVG from 'react-inlinesvg';

const IconSelector = () => {
  const [selectedIcon, setSelectedIcon] = useState('/path/to/default-icon.svg');

  return (
    <div>
      <select onChange={(e) => setSelectedIcon(e.target.value)}>
        <option value="/path/to/icon1.svg">Icon 1</option>
        <option value="/path/to/icon2.svg">Icon 2</option>
        <option value="/path/to/icon3.svg">Icon 3</option>
      </select>
      <InlineSVG src={selectedIcon} />
    </div>
  );
};

export default IconSelector;

自定义样式和处理

你可以通过 beforeInjection 钩子在 SVG 加载后对其进行自定义处理，例如添加类名或修改样式：

import React from 'react';
import InlineSVG from 'react-inlinesvg';

const StyledSVG = () => {
  return (
    <div>
      <InlineSVG
        src="/path/to/my-icon.svg"
        beforeInjection={(svg) => {
          svg.classList.add('custom-svg');
          svg.setAttribute('style', 'fill: red;');
        }}
      />
    </div>
  );
};

export default StyledSVG;

典型生态项目

react-inline-svg 可以与其他 React 生态项目很好地集成，例如：

• React Router: 在路由切换时动态加载不同的 SVG 图标。
• Redux: 在状态管理中存储和动态加载 SVG 图标。
• Styled Components: 使用样式化组件来进一步自定义 SVG 的样式。

通过这些集成，你可以构建更加动态和交互性的 React 应用。