【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】Webサーバー「Unicorn」の基本情報と実装方法
# はじめに Railsアプリを本番環境で稼働させるには、クライアントからのリクエストを捌くWebサーバーを導入する必要があります。WebサーバーはクライアントからのリクエストをRailsアプリに伝達し、Railsアプリで処理されたレスポンスをク [...]
2021年4月15日 12:17
【Rails】デプロイツール「Capistrano」の基本情報と実装方法
# はじめに アプリを本番環境にアップロードして誰でもアクセスできる状態にすることをデプロイと言います。デプロイで行うべきことは多岐にわたります。Railsアプリの場合で言えば、本番環境にアップロードすることはもちろんですが、Gemのインストール [...]
2021年4月14日 9:56
【Rails】Webpackerの基本情報と実装方法
# はじめに Rails 6からWebpackerが正式採用されました。Rails 5ではオプションで追加することができたWebpackerですが、Rails 6からは普通にアプリを作成するだけでWebpackerがインストールされ、必要な設定も [...]
2021年4月12日 14:36
【Rails】アセットパイプライン(Sprockets)の基本情報と実装方法
# はじめに Ruby on Railsにはアセットパイプラインという機能があります。アセットパイプラインは画像、CSS、JavaScriptといったアセットファイルを連結/圧縮することでRailsアプリを高速化します。また、より高級な言語で書か [...]
2021年4月11日 14:08
【Rails】Turbolinksの基本情報と実装方法
# はじめに Ruby on Railsにはページの遷移を高速化するTurbolinksという機能があります。Turbolinksは優れたJavaScriptライブラリですが、Rails 5からは標準で有効化されているため、Turbolinksを [...]
2021年4月10日 17:59