Skip to content

docs: add note about transformers like react-native-svg-transformer #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/docs/docs/guides/usage-with-react-navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,39 @@ Function that given `{ focused: boolean }` returns `ImageSource` or `AppleIcon`
SF Symbols are only supported on Apple platforms.
:::

:::warning

Metro transformers that modify the import resolutions of images to something that is *not* React Native's `ImageSource` will break this. A notable community example of such is [react-native-svg-transformer](https://github.com/kristerkari/react-native-svg-transformer).

For best results, avoid the use of such transformers altogether.

If however, it is necessary to use such a transformer, you can modify your `metro.config.js` file to resolve the asset to `ImageSource` with another extension.

For example, with `react-native-svg-transformer`, you can resolve the `svg` extension to use `react-native-svg-transformer`, and use an alternative extension like `svgx` to resolve it normally with React Native's default behavior.

To do so, change the extension of your icon SVG file from `.svg` to `.svgx` and modify your `metro.config.js` file like so:

```diff
config.transformer.babelTransformerPath = require.resolve(
"react-native-svg-transformer"
);
config.resolver.assetExts = config.resolver.assetExts.filter(
(ext) => ext !== "svg"
);

+ config.resolver.assetExts = [...config.resolver.assetExts, "svgx"];

config.resolver.sourceExts = [...config.resolver.sourceExts, "svg"];
```

Then change your require calls like so:
```
tabBarIcon: () => require('person.svgx')
```

:::


#### `tabBarBadge`

Badge to show on the tab icon.
Expand Down