
react-native-svg
provides SVG support to React Native on iOS, Android, macOS, Windows, and a compatibility layer for the web.Check out the Example app
Features
- Supports most SVG elements and properties (Rect, Circle, Line, Polyline, Polygon, G ...).
- Easy to convert SVG code to react-native-svg.
Installation
With expo-cli
ā The Expo client app comes with the native code installed!
Install the JavaScript with:
expo install react-native-svg
š See the Expo docs for more info or jump ahead to Usage.
With react-native-cli
- Install library
from npm
```bash
npm install react-native-svg
```
from yarn
```bash
yarn add react-native-svg
```
- Link native code
```bash
cd ios && pod install
```
Supported react-native versions
| react-native-svg | react-native | | ---------------- | ------------ | | 3.2.0 | 0.29 | | 4.2.0 | 0.32 | | 4.3.0 | 0.33 | | 4.4.0 | 0.38 | | 4.5.0 | 0.40 | | 5.1.8 | 0.44 | | 5.2.0 | 0.45 | | 5.3.0 | 0.46 | | 5.4.1 | 0.47 | | 5.5.1 | >=0.50 | | >=6 | >=0.50 | | >=7 | >=0.57.4 | | >=8 | >=0.57.4 | | >=9 | >=0.57.4 | | >=12.3.0 | >=0.64.0 |Support for Fabric
Fabric is React Native's new rendering system. As of version13.0.0
of this project, Fabric is supported only for react-native 0.69.0+. Support for earlier versions is not possible due to breaking changes in configuration.| react-native-svg | react-native | | ---------------- | ------------ | | >=13.0.0 | 0.69.0+ | | >=13.6.0 | 0.70.0+ |
Troubleshooting
Unexpected behavior
If you have unexpected behavior, please create a clean project with the latest versions of react-native and react-native-svgreact-native init CleanProject
cd CleanProject/
yarn add react-native-svg
cd ios && pod install && cd ..
Make a reproduction of the problem in
App.js
react-native run-ios
react-native run-android
Adding Windows support
npx react-native-windows-init --overwrite
cd windows\<AppName>
- Open
<AppName>.vcxproj
RN 0.68+
- Scroll to the bottom until you find:
```xml
<ItemGroup>
<PackageReference Include="Microsoft.Windows.CppWinRT" Version="X.X.XXXXXX.X" />
</ItemGroup>
```
- Add the following to that
<ItemGroup>
```xml
<PackageReference Include="Win2D.uwp" Version="1.26.0" />
```
Pre RN 0.68
- Scroll to the bottom until you find:
```xml
<ImportGroup Label="ExtensionTargets">
```
- Add the following to that
<ImportGroup>
```xml
<Import Project="$(SolutionDir)\packages\Win2D.uwp.1.26.0\build\native\Win2D.uwp.targets" Condition="Exists('$(SolutionDir)\packages\Win2D.uwp.1.26.0\build\native\Win2D.uwp.targets')" />
```
Opening issues
Verify that it is still an issue with the latest version as specified in the previous step. If so, open a new issue, include the entireApp.js
file, specify what platforms you've tested, and the results of running this command:react-native info
If you suspect that you've found a spec conformance bug, then you can test using your component in a react-native-web project by forking this codesandbox, to see how different browsers render the same content: If any evergreen browser with significant userbase or other svg user agent renders some svg content better, or supports more of the svg and related specs, please open an issue asap.
Usage
To check how to use the library, see USAGE.mdTODO:
- Filters (connected PR)
Known issues:
- Unable to apply focus point of RadialGradient on Android.