【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】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12