svgr の使い方

svgr.svgファイルから React コンポーネントに楽に変換できる CLI ツール(モジュール)です。

使うには実行ファイルのインストールが必要です。

yarn add -D @svgr/cli

Twitter ロゴの SVG を変換

こんな<svg>twitter.svgという名前で用意しました。

<svg
  aria-hidden="true"
  data-prefix="fab"
  data-icon="twitter"
  class="svg-inline--fa fa-twitter fa-w-16"
  role="img"
  xmlns="http://www.w3.org/2000/svg"
  viewBox="0 0 512 512"
>
  <path
    fill="currentColor"
    d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"
  ></path></svg
>

このファイルに対して変換を行ってみます。

2つのオプションがついています。   --icon<svg>width:1emheight:1emを付けるオプションで、--replace-attr-valuesはマッチした属性値を渡した値で上書きするオプションです。

npx @svgr/cli --icon --replace-attr-values "currentColor=#46a1eb" twitter.svg

# ファイルに出力
# yarn add -D @svgr/cli
# yarn --silent svgr --icon --replace-attr-values "currentColor=#46a1eb" twitter.svg > svg-twitter.svg

以下のような結果になりました。

import React from "react";

const SvgTwitter = props => (
  <svg
    aria-hidden="true"
    data-prefix="fab"
    data-icon="twitter"
    className="twitter_svg__svg-inline--fa twitter_svg__fa-twitter twitter_svg__fa-w-16"
    viewBox="0 0 512 512"
    width="1em"
    height="1em"
    {...props}
  >
    <path
      fill="#fff"
      d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"
    />
  </svg>
);

svg の中身を React 内で触りたい場合

例えば Snapsvg などで SVG の中の要素を触りたい時に必要かなという設定です。

svgrコマンドをそのまま使うとsvgoによる最適化が行われてしまい、望んだ形で変換できない時があるかもしれません。その場合は.svgo.ymlという設定ファイルをプロジェクトルートへ置き、設定を書くことで直すことができるかもしれません。

一部タグがおかしい

デフォルトでは<polygon points="...">といったタグは<path d="...">に変換されます。これを防ぐには、convertShapeToPathを切ります。

plugins:
  - convertShapeToPath: false

一部タグが消える

僕が遭遇したものだと、<clip-path>が消えました。これは以下の2行を設定することで消されることを防げました。

plugins:
  - cleanupIDs: false
  - removeUnknownsAndDefaults: false

TypeScript で出力した .jsx を読めるように

以下のようなファイルをaaa.jsxであれば、aaa.d.tsとなるように作成し、SVGComponentexportしている名前に変換します。

import React from 'react';

declare const SVGComponent: React.SFC;
export default SVGComponent;

これでimport Aaa from './aaa';などで.tsxに読み込めます。