【Rails】Webpackerで画像ファイルを管理し、CSSやビューから参照する方法

2020年7月30日 15:51

はじめに

Rails6から標準導入されたWebpackerは、JavaScriptやCSSだけでなく画像ファイルの管理も行えます。

今回はWebpackerで画像ファイルを管理し、CSSやビューから参照する方法を解説します。

画像ファイルの配置場所

Webpackerで画像ファイルを管理するには、Webpackerのデフォルトソースパス(app/javascript/)配下にimagesディレクトリを新規作成し、その中に画像ファイルを配置します(ディレクトリ名は任意)。

また、ディレクトリは多重階層(app/javascript/images/works/)にしても問題ありません。

画像ファイルの参照

インポート

Webpackerに画像ファイルをインポートするには、app/javascript/packs/application.jsに以下を追記します。

const images = require.context('../images', true)
const imagePath = (name) => images(name, true)

Rails6であれば最初から記述されているかと思います。ただしコメントアウトされているので外しておきましょう。

CSSから参照

CSSから画像ファイルを参照するには、以下のように記述します。

.jumbotron {
  background-image: url("../images/cover.jpg");
}

CSSファイルのあるディレクトリから相対パスで指定します。

Sprockets管理下の画像ファイル(app/assets/images/)を参照するときはimage-urlを使う必要がありましたが、Webpacker管理下の画像ファイルの場合は通常のurlが使えます。

ビューから参照

ビューから画像ファイルを参照するには、以下のように記述します。

<%= image_pack_tag 'media/images/cover.jpg' %>

画像ファイルのURLを指定して参照することも可能です。

<img src="<%= asset_pack_path 'media/images/works/cover.jpg' %>">

エラーが表示される場合

Webpacker管理下の画像ファイルを参照しようとすると、以下のエラーが表示される場合があります。

Webpacker::Manifest::MissingEntryError in Statics#index
Showing /path/to/project/app/views/statics/index.html.erb where line #4 raised:

Webpacker can't find media/images/cover.jpg in /path/to/project/public/packs/manifest.json.

このエラーは、配置した画像ファイルがWebpackerに認識されていないために表示されます。

画像ファイルを配置した後は、以下のコマンドを実行してWebpackのビルドを行いましょう。

$ bin/webpack

関連記事

【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01
【Rails】IDとパスワードによる認証機能の実装【初学者】
# はじめに 大抵のWebアプリでは、ユーザー登録/解除、ログイン/ログアウトといった認証機能を持っています。Railsには簡単に認証機能を導入できる「device」というGemが用意されています。「devise」は多くのRailsアプリで使われ [...]
2021年11月27日 13:00