Skip to content
Import SVG files in your React Native project the same way that you would in a Web application.
Branch: master
Clone or download
kristerkari Merge pull request #25 from inf3cti0n95/patch
docs: appropriate type for content in TS definition
Latest commit 8de6adb May 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images Add logos Sep 13, 2018
.editorconfig Initial commit Aug 2, 2018
.gitignore Initial commit Aug 2, 2018
.prettierignore Initial commit Aug 2, 2018
CHANGELOG.md Prepare version 0.13.0 Apr 19, 2019
LICENSE Initial commit Aug 2, 2018
README.md appropriate type for content in TS definition May 23, 2019
index.js Use process.cwd instead of __dirname Apr 19, 2019
package.json Prepare version 0.13.0 Apr 19, 2019
yarn.lock Update dev deps Apr 13, 2019

README.md

react-native-svg-transformer NPM version Downloads per month contributions welcome

React Native SVG transformer allows you import SVG files in your React Native project the same way that you would in a Web application when a using library like SVGR to transform your imported SVG images into React components.

This makes it possible to use the same code for React Native and Web.

Usage

Import your .svg file inside a React component:

import Logo from "./logo.svg";

You can then use your image as a component:

<Logo width={120} height={40} />

If you use React Native version 0.56 or older, you need to rename your .svg files to .svgx.

Demo (iOS/Android/Web)

Installation and configuration

Step 1: Install react-native-svg library

Make sure that you have installed and linked react-native-svg library:

Step 2: Install react-native-svg-transformer library

yarn add --dev react-native-svg-transformer

Step 3: Configure the react native packager

For React Native v0.57 or newer / Expo SDK v31.0.0 or newer

Merge the contents from your project's metro.config.js file with this config (create the file if it does not exist already).

metro.config.js:

const { getDefaultConfig } = require("metro-config");

module.exports = (async () => {
  const {
    resolver: { sourceExts, assetExts }
  } = await getDefaultConfig();
  return {
    transformer: {
      babelTransformerPath: require.resolve("react-native-svg-transformer")
    },
    resolver: {
      assetExts: assetExts.filter(ext => ext !== "svg"),
      sourceExts: [...sourceExts, "svg"]
    }
  };
})();

If you are using Expo, you also need to add this to app.json:

{
  "expo": {
    "packagerOpts": {
      "config": "metro.config.js"
    }
  }
}

For React Native v0.56 or older

React Native versions older than 0.57 do not support running the transformer for .svg file extension. That is why a .svgx file extension should be used instead for your SVG files. This is fixed in React Native 0.57 and newer versions.

Add this to your rn-cli.config.js (create the file if it does not exist already):

module.exports = {
  getTransformModulePath() {
    return require.resolve("react-native-svg-transformer");
  },
  getSourceExts() {
    return ["js", "jsx", "svgx"];
  }
};

For Expo SDK v30.0.0 or older

If you are using Expo, instead of adding the rn-cli.config.js file, you need to add this to app.json:

{
  "expo": {
    "packagerOpts": {
      "sourceExts": ["js", "jsx", "svgx"],
      "transformer": "node_modules/react-native-svg-transformer/index.js"
    }
  }
}

Using TypeScript

If you are using TypeScript, you need to add this to your declarations.d.ts file (create one if you don't have one already):

declare module '*.svg' {
  import { SvgProps } from 'react-native-svg'
  const content: React.ComponentClass<SvgProps, any>
  export default content
}

Configuring SVGR (how SVG images get transformed)

SVGR has a configuration file, which makes it possible for you to customize how SVG images get transformed to React/React Native.

Read more about the configuration options: Configuring SVGR and SVGR options.

For example, if you want to change SVG image's fill color from red to currentColor (keep in mind that this will be used for all SVG images in your app).

.svgrrc

{
  "replaceAttrValues": {
    "red": "currentColor"
  }
}

Dependencies

In addition to React Native, this transfomer depends on the following libraries:

You can’t perform that action at this time.