react-native-vector-image-plugin

Config plugin to auto configure react-native-vector-image when the native code is generated (expo prebuild).

Please have a look at "react-native-vector-image" for further instructions.

Some of the benefits are

• Faster render – ~5x faster than react-native-svg.
• Smaller JS bundle = faster startup.
• Native support for dark mode.

Expo installation

Tested against Expo SDK 45

This package cannot be used in the "Expo Go" app because it requires custom native code. First install the package with yarn, npm, or expo install.

expo install react-native-vector-image @klarna/react-native-vector-drawable
expo install @zamplyy/react-native-vector-image-plugin

After installing this npm package, add the config plugin to the plugins array of your app.json or app.config.js:

{
  "expo": {
    "plugins": ["@zamplyy/react-native-vector-image-plugin"]
  }
}

Next, rebuild your app as described in the "Adding custom native code" guide.

Example

{
  "expo": {
    "plugins": [
      [
        "@zamplyy/react-native-vector-image-plugin",
        {
          "stripSvgs": false // default false (if true, svgs will be removed from bundle. expo-updates package crashes when svgs it expects in the bundle are not there)
          "customMetroConfigFile": "name of custom mentro config file (default is metro.config.js)",
          "resetCache": false // Tell CLI to reset metro cache when bundling svgs (default false),
          "customEntryFile": "name of custom entry file" // Default is index.js
        }
      ]
    ]
  }
}

Contributing

Contributions are very welcome!