Webpackプロジェクトを構築し、ブラウザのタブに標準的な地球儀アイコンや空白の四角が表示された経験があるbihoca、mpoca。Webpackは初期状態ではfaviconを扱わないため、自分で設定する必要があります。ただし、配置する場所とlink tagの挿入方法を抑えれば、設定ファイルに数行追加するだけで導入できます。
このガイドでは、faviconファイルの配置からbrowser上での確認まで、Webpackプロジェクトにfaviconを追加する手順を解説します。ファイルをコピーするだけの方法とHtmlWebpackPluginを使う方法、および多くの開発者がつまずくポイントも取り上げます。
前提条件
functioning Webpackプロジェクトがあり、webpackとwebpack-cliがインストールされている必要があります。HTMLの生成にhtml-webpack-pluginを使っている場合は、より顺畅です。このガイドでは推奨する方法としてHtmlWebpackPluginを使用します。また、使用するfaviconファイル(ICO、PNG、SVG)を用意しておく必要があります。必要であれば、複数サイズのICOを生成するガイドで作成できます。
ステップ1: faviconをプロジェクトに配置する
静态アセット用のフォルダがなければ作成します。一般的にはsrc/assets/またはpublic/が使われます。faviconファイルをそのフォルダに配置してください。ここでは、browserとの互換性を最大限確保するため、favicon.icoという名前にします。favicon.pngやfavicon.svgも使用できますが、SVGは現代のbrowserでサポートされている一方、古いbrowserでは代替ファイルが必要です(SVGとPNG fallbackの組み合わせを参照してください)。
このガイドでは、ファイルをsrc/assets/favicon.icoに配置 Assumingとします。
ステップ2: Webpackでfaviconをコピー하도록設定する
Webpackにこのファイルを認識させ、ビルド出力に含める必要があります最も単純な方法として、copy-webpack-pluginを使用します。インストールします。
npm install --save-dev copy-webpack-plugin次に、webpack.config.jsに追加します。
const CopyPlugin = require('copy-webpack-plugin');
module.exports = {
// ... other config
plugins: [
new CopyPlugin({
patterns: [
{ from: 'src/assets/favicon.ico', to: 'favicon.ico' }
]
})
]
};これにより、faviconが出力ディレクトリのルート(例:dist/favicon.ico)にコピーされます。linkタグが存在しない場合、ブラウザは自動的に/favicon.icoをリクエストするので、これだけでも機能します。ただし、明示的なlinkタグの方が、制御やICO以外の形式への対応に優れています。
手順3: HtmlWebpackPluginでlinkタグを挿入する
html-webpack-pluginを使用する場合、HTMLテンプレートにfaviconのlinkタグを直接追加できます。通常はsrc/にあるindex.htmlテンプレートの<head>内に、次を追加します。
<link rel='icon' href='favicon.ico' type='image/x-icon'>ファイルが出力ルートにコピーされるため、相対パスfavicon.icoは正しく解決されます。サブディレクトリから配信する場合は、/favicon.icoのような絶対パスを使うか、WebpackでpublicPathを設定します。
SVGのfaviconの場合は、次を使用します。
<link rel='icon' href='favicon.svg' type='image/svg+xml'>PNGの場合は次のとおりです。
<link rel='icon' href='favicon.png' type='image/png'>rel='icon'属性は、サイトのアイコンを指定する方法としてHTML標準で定義されています。ブラウザはこれを利用して、タブ、ブックマーク、履歴に最も適したアイコンを選択します。
手順4: ビルドして確認する
ビルドコマンドを実行します(例:npm run build)。出力フォルダーにfavicon.icoが配置されているか確認します。次に、ビルド結果をローカルで配信して(例:npx serve dist)、ブラウザで開きます。タブにはアイコンが表示されるはずです。表示されない場合は、キャッシュを回避するためハードリロード(Ctrl+Shift+RまたはCmd+Shift+R)を行ってください。
また、ページのソースを確認して、linkタグが存在し、パスが正しいことも確認できます。
よくある落とし穴
- 出力パスが不正:
CopyPluginのtoにサブフォルダを含むパスを指定した場合、linkタグのパスも一致させる必要があります。たとえば、to: 'assets/favicon.ico'なら、href='assets/favicon.ico'と指定します。 - 本番環境でファイルが見つからない:開発時のみアセットをコピーする構成では、本番ビルドにファイルが含まれないことがあります。
CopyPluginがすべてのmodeで実行されるように設定してください。 - キャッシュの問題:ブラウザーはfaviconを強くキャッシュします。faviconを更新するときは、
favicon.ico?v=2のようなquery stringを使うか、buildにcache-bustingを設定してください(cache busting best practicesを参照)。 - SVGのfallbackがない:古いブラウザーはSVG faviconを無視します。ICOまたはPNGのfallbackを必ず含めてください。
- ファイルがルートにない:linkタグを使わず、デフォルトの
/favicon.icoへのリクエストに依存する場合、ファイルは配信ディレクトリのルートに配置する必要があります。
まとめ
Webpackプロジェクトにfaviconを追加する作業XD?ファイルを出力先にコピーすることと、HTMLから参照することの2つの要点を知れば_unlocked。copy-webpack-pluginでアセットをコピーし、テンプレートのlink rel='icon'タグを追加します。これで完了です。ブラウザーのタブにも見栄えのよさが加わります。
一式のfaviconセット(ICO、PNG、Apple Touch、manifest icons)を生成する必要がある場合は、Mzu favicondlをお試しください。すべてのファイルを一括で作成できます。