next-react-svg icon indicating copy to clipboard operation
next-react-svg copied to clipboard

Transform your svg image to a React component.

Next React Svg

npm version

Transform your svg image to a React component.

Features

  • Svg properties
  • React props and events

Installation

yarn add next-react-svg -E

Usage

Create a next.config.js in your project and pass an include to define the svg folder localization.

const withReactSvg = require('next-react-svg')
const path = require('path')

module.exports = withReactSvg({
  include: path.resolve(__dirname, 'src/assets/svg'),
  webpack(config, options) {
    return config
  }
})
import Logo from 'assets/svg/Logo.svg';

export default () => (
  <Logo />
);

Typescript

Next > 11

Create a additional.d.ts file at the root of your project. Add the following reference:

/// <reference types="next-react-svg" />

Add additional.d.ts to the include array of your tsconfig.json.

Next <= 11

Add the reference below into your next-env.d.ts file.

/// <reference types="next-react-svg" />