react-native-svgを使ってReact NativeでSVGを扱う

はじめに

React NativeではSVGを表示することができません。そのため画像素材などはpngなどを用意するのが一般的でした。ですが、react-native-svgなどのライブラリを使用することでReact NativeでもSVG画像を使用することができます。今回はreact-native-svgを使用したSVG画像の使用手順についてご紹介します。

react-native-svgとはReact Native上でSVG画像を表示するためにするライブラリです。

https://github.com/react-native-svg/react-native-svg

使い方もSVGを触ったことがある人であれば難しくなく扱うことができます。

導入手順

React Native

導入についてはReact Nativeのプロジェクト内で以下のコマンドを入力してインストールします。

$ yarn add react-native-svg

React Native Expo

React Native Expoプロジェクトで追加する場合にはこちらでインストールします。

$ expo install react-native-svg

インストールが完了すれば準備完了です。

使用方法

で実際に使用手順について解説をしていきます。今回は以下のようなSVGを用意しました。

見た目

Ellipse 1.png (1.4 kB)

ソースコード

<svg width="100" height="100" viewBox="0 0 100 100" fill="none">
  <circle cx="50" cy="50" r="50" fill="#40ff00">
  </circle>
</svg>

react-native-svgはSVGファイルをReact Native用に書き換える必要があるので上記SVGファイルを元に書き換えをしていきます。まずは実際にSVGを表示したいファイルにreact-native-svgをimportします。

import Svg, {
  Circle,
  Ellipse,
  G,
  Text,
  TSpan,
  TextPath,
  Path,
  Polygon,
  Polyline,
  Line,
  Rect,
  Use,
  Image,
  Symbol,
  Defs,
  LinearGradient,
  RadialGradient,
  Stop,
  ClipPath,
  Pattern,
  Mask,
} from 'react-native-svg';

これらを見て気がつく方もいるかもしれませんが、これらはすべてSVGのタグになっています。元々のSVGのタグは小文字ですがreact-native-svgではすべて頭の文字が大文字になっています。そのため、もともとのSVGファイルを表示したい箇所に貼り付けたら、SVGのタグをすべて大文字に変更します。

import Svg, { Circle } from 'react-native-svg';

const Icon = props => {
  return (
    <view>
      <svg width="100" height="100" viewBox="0 0 100 100" fill="none">
        <circle cx="50" cy="50" r="50" fill="#40ff00"></circle>
      </svg>
    </view>
  );
}

これでsvg画像をReact Nativeで使用することができます。

SVGアイコンをコンポーネントとして活用する

react-native-svgで記述したsvgは外部からpropsを渡すことで通常のReact Native同様、値の受け取りが可能です。そのため以下のようにpropsを設定することで、アイコンの大きさや色などを可変にすることができるコンポーネントを実装することができます。

import Svg, { Circle } from 'react-native-svg';

const Icon = props => {
  const { size = 80, color = "#ff0000" } = props;
  return (
    <view>
      <svg width="{size}" height="{size}" viewBox="0 0 100 100" fill="none">
        <circle cx="50" cy="50" r="50" fill="{color}/"></circle>
      </svg>
    </view>
  );
}

まとめ

今回はreact-native-svgを使用したReact Nativeでのsvg画像の利用についてご紹介しました。SVG画像を使用することで端末によって画像が荒くなったりすることを防ぐことができますし、端末の解像度に応じて複数枚画像を用意する手間もなくなるので便利です。活用してみてはいかがでしょうか。