react-native-svg-transformer

What is react-native-svg-transformer?

The react-native-svg-transformer package is a transformer for React Native that allows you to import and use SVG files as React components. This package simplifies the process of working with SVGs in a React Native project by transforming SVG files into components that can be easily styled and manipulated.

What are react-native-svg-transformer's main functionalities?

Importing SVG files

This feature allows you to import SVG files directly into your React Native components. The SVG file is transformed into a React component that can be used like any other component.

import Logo from './logo.svg';

const App = () => (
  <View>
    <Logo width={120} height={40} />
  </View>
);

Styling SVG components

You can style the imported SVG components using standard React Native styles. This example demonstrates how to change the fill color of an SVG component.

import Logo from './logo.svg';

const App = () => (
  <View>
    <Logo width={120} height={40} style={{ fill: 'blue' }} />
  </View>
);

Using SVG components with props

SVG components can accept props, allowing you to dynamically change their attributes. This example shows how to set the fill color of an SVG component using a prop.

import Logo from './logo.svg';

const App = () => (
  <View>
    <Logo width={120} height={40} fill='red' />
  </View>
);

Other packages similar to react-native-svg-transformer

react-native-svg

react-native-svg is a popular library for rendering SVG images in React Native. It provides a set of SVG elements that can be used to create complex graphics. Unlike react-native-svg-transformer, which focuses on transforming SVG files into components, react-native-svg provides a more comprehensive set of tools for working with SVGs directly in your code.

react-native-vector-icons

react-native-vector-icons is a library that provides a set of customizable icons for React Native. While it does not specifically handle SVG files, it offers a wide range of vector icons that can be used in place of SVGs. This package is useful if you need a variety of icons without the need to manage SVG files directly.

svgr

svgr is a tool that transforms SVGs into React components. It can be used in both web and React Native projects. While svgr is not specifically designed for React Native, it can be integrated into a React Native project to achieve similar functionality to react-native-svg-transformer.

README

react-native-svg-transformer

React Native SVG transformer allows you to import SVG files in your React Native project the same way that you would in a Web application when using a 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} />

Demo / Expo demo (iOS/Android/Web)

• react-native-svg-example
• react-native-svg-expo-example

Installation and configuration

Step 1: Install react-native-svg library

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

• https://github.com/react-native-community/react-native-svg#installation

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

npm install --save-dev react-native-svg-transformer

or

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

Step 3: Configure the react native packager

For Expo SDK v41.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("expo/metro-config");

module.exports = (() => {
  const config = getDefaultConfig(__dirname);

  const { transformer, resolver } = config;

  config.transformer = {
    ...transformer,
    babelTransformerPath: require.resolve("react-native-svg-transformer/expo")
  };
  config.resolver = {
    ...resolver,
    assetExts: resolver.assetExts.filter((ext) => ext !== "svg"),
    sourceExts: [...resolver.sourceExts, "svg"]
  };

  return config;
})();

---

For React Native v0.72.1 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, mergeConfig } = require("@react-native/metro-config");

const defaultConfig = getDefaultConfig(__dirname);
const { assetExts, sourceExts } = defaultConfig.resolver;

/**
 * Metro configuration
 * https://reactnative.dev/docs/metro
 *
 * @type {import('metro-config').MetroConfig}
 */
const config = {
  transformer: {
    babelTransformerPath: require.resolve(
      "react-native-svg-transformer/react-native"
    )
  },
  resolver: {
    assetExts: assetExts.filter((ext) => ext !== "svg"),
    sourceExts: [...sourceExts, "svg"]
  }
};

module.exports = mergeConfig(defaultConfig, config);

---

For React Native v0.59 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/react-native"
      )
    },
    resolver: {
      assetExts: assetExts.filter((ext) => ext !== "svg"),
      sourceExts: [...sourceExts, "svg"]
    }
  };
})();

React Native projects using Expo modules

Some React Native projects are using Expo modules without using expo-cli.

In such projects Expo's transformer is selected by default, and can be overwritten to correctly use React Native's transformer by adding react-native to the require path:

-require.resolve("react-native-svg-transformer")
+require.resolve("react-native-svg-transformer/react-native")

You can also force Expo's transformer to always be used:

-require.resolve("react-native-svg-transformer")
+require.resolve("react-native-svg-transformer/expo")

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 React from "react";
  import { SvgProps } from "react-native-svg";
  const content: React.FC<SvgProps>;
  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 (create the file in your project's root folder if it does not exist)

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

Changing SVG fill color in JS Code

Edit your .svgrrc file and include a line for replaceAttrValues that matching a hex code to {props.fill}

{
  "replaceAttrValues": {
    "#000": "{props.fill}"
  }
}

And then make sure your path tag inside the SVG file fill attribute is the hex code (in this case #000).

<svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg">
  <path d="M2.965 6.0925C4.045 8.215 ..." fill="#000"/>
</svg>

You can then use your image as a component:

<Logo width={120} height={40} fill={"any color"} />

Usage with Jest

To use Jest to test your React Native components that import .svg images, you need to add this configuration that mocks the SVG images that are transformed to React components:

__mocks__/svgMock.js:

module.exports = "SvgMock";

Then, depending on where you have your Jest configuration:

package.json:

{
  "jest": {
    "moduleNameMapper": {
      "\\.svg": "<rootDir>/__mocks__/svgMock.js"
    }
  }
}

or

jest.config.js:

module.exports = {
  moduleNameMapper: {
    "\\.svg": "<rootDir>/__mocks__/svgMock.js"
  }
};

Rendering custom fonts in iOS

At the moment react-native-svg does not support custom font families in iOS right out of the box. A workaround is to take your .svg with custom fonts and convert it to outlines. This will replace text tags for path tags in your .svg file.

Dependencies

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

• react-native-svg
• @svgr/core
• @svgr/plugin-jsx
• @svgr/plugin-svgo
• path-dirname

Changelog

1.5.0

• Added: allow user to select between expo and react-native transformer by using react-native-svg-transformer/react-native or react-native-svg-transformer/expo as the transformer path (#366).