【Rails】Webpackerを使ってjQueryとBootstrapを管理する方法

2021年4月5日 23:07

はじめに

本記事では、Rails 6.0から導入された「Webpacker」を使ってjQueryとBootstrapを管理する方法を説明します。

WebpackerでjQueryとBootstrapを管理

Railsアプリの作成

以下のコマンドを実行して、新しいRailsアプリを作成します。コマンド引数に_6.0.0_をつけることで作成するアプリのRailsバージョンを指定することができます。

$ rails _6.0.0_ new test_app

以下のコマンドを実行して、コントローラーとビューを作成します。

$ rails g controller Statics index

テストサーバーを起動しRailsアプリが作成できているか確認してみます。

$ rails s

テストサーバーが起動したら、ブラウザでhttp://localhost:3000/statics/indexにアクセスします。以下のように表示されていればOKです。

jQueryとBootstrapをインストール

以下のコマンドを実行して、jQueryとBootstrapをインストールします。popper.jsはBootstrapのツールチップを使うために必要になります。

$ yarn add jquery bootstrap popper.js

package.jsonにjQueryとBootstrapが追加されていればOKです。

package.json

{
  "name": "test_app",
  "private": true,
  "dependencies": {
    "@rails/actioncable": "^6.0.0",
    "@rails/activestorage": "^6.0.0",
    "@rails/ujs": "^6.0.0",
    "@rails/webpacker": "^4.2.0",
    "jquery": "^3.4.1",
    "bootstrap": "^4.4.1",
    "popper.js": "^1.16.0",
    "turbolinks": "^5.2.0"
  },
  "version": "0.1.0",
  "devDependencies": {
    "webpack-dev-server": "^3.9.0"
  }
}

jQueryの管理

app/javascript/packs/application.jsに以下を追記します。

application.js

require("jquery")

config/webpack/environment.jsに以下を追記します。

environments.js

const webpack = require('webpack')

environment.plugins.prepend('Provide',
  new webpack.ProvidePlugin({
    $: 'jquery/src/jquery',
    jQuery: 'jquery/src/jquery'
  })
)

Bootstrapの管理

app/javascript/配下にsrcというディレクトリを作成し、その中にapplication.scssというファイルを作成します。作成したapplication.scssに以下を記述します。

application.scss

@import '~bootstrap/scss/bootstrap';

app/javascript/packs/application.jsに以下を追記します。

application.js

import 'bootstrap'
import '../src/application.scss'

動作確認

確認のため、app/views/statics/index.html.erbを以下のように変更します。ページ読み込み時にjQueryでBootstrapのスタイルを適用させています。

index.html.erb

<h1>Statics#index</h1>
<p>Find me in app/views/statics/index.html.erb</p>

<!-- 以下を追記 -->
<script>
  $(window).on('load', function() {
    $('body').addClass('bg-dark');
    $('body').addClass('text-light');
  });
</script>

テストサーバーを再起動します。

$ rails s

http://localhost:3000/statics/indexにアクセスします。以下のように、ページ読み込み時にBootstrapのスタイルが適用されていればOKです。

ちなみに、Webpacker管理下のファイルが更新されたときはWebpackerのコンパイルが走ります。テストサーバーを起動したターミナルを見てみると、以下のようなログが出力されています。コンパイルに約37秒かかっていることがわかります。

[Webpacker] Compiling...
[Webpacker] Compiled all packs in /Users/user/Products/test_app/public/packs
[Webpacker] Hash: 53154d7baad00c6a1252
Version: webpack 4.41.2
Time: 3718ms

設定ファイル全文

app/javascript/packs/application.js

// This file is automatically compiled by Webpack, along with any other files
// present in this directory. You're encouraged to place your actual application logic in
// a relevant structure within app/javascript and only use these pack files to reference
// that code so it'll be compiled.

require("@rails/ujs").start()
require("turbolinks").start()
require("@rails/activestorage").start()
require("channels")
require("jquery")

// Uncomment to copy all static images under ../images to the output folder and reference
// them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)
// or the `imagePath` JavaScript helper below.
//
// const images = require.context('../images', true)
// const imagePath = (name) => images(name, true)

import 'bootstrap'
import '../src/application.scss'

app/javascript/src/application.scss

@import '~bootstrap/scss/bootstrap';

config/webpack/evironment.js

const { environment } = require('@rails/webpacker')

const webpack = require('webpack')

environment.plugins.prepend('Provide',
  new webpack.ProvidePlugin({
    $: 'jquery/src/jquery',
    jQuery: 'jquery/src/jquery'
  })
)

module.exports = environment

まとめ

Rails 6.0から導入されたWebpackerを使ってjQueryとBootstrapを管理する方法を説明しました。参考にしていただければと思います。

関連記事

【Rails】ダウンロードしたフリーフォントをWebpackerを使って導入する方法
# はじめに Webサイトのデザインを彩るひとつの要素にフォントの種類があります。Google Fontsの登場により、様々なフォントが手軽に導入できるようになりました。しかし、世の中にはGoogle Fontsが提供するフォント以外にもたくさん [...]
2021年10月16日 13:26
【Rails】mimemagicに依存しているRailsアプリでbundle installコマンドが失敗する事象の対処法
# はじめに Railsアプリで`bundle install`コマンドを実行しようとしたところ、以下のエラーメッセージが出力されコマンドに失敗しました。 ``` Your bundle is locked to mimemagic (0 [...]
2021年10月14日 14:44
【Rails】macOSのアップデート後にrailsコマンドが失敗する事象の対処法
# はじめに 久しぶりにRailsアプリに手を入れようと思い、`rails server`コマンドを実行してRailsサーバーを立ち上げようとしたところ、エラーが出て起動に失敗してしまいました。 前回までの間にしたことの中で思い当たることと [...]
2021年10月14日 12:11
【Rails】Railsアプリのデバッグ《マルチデバイス篇》
# はじめに 近年のWebアプリはレスポンシブ対応が当たり前になっています。最低でもPCとスマートフォンに対応したデザイン、ときにはその中間のタブレットに対応したデザインなんかも作成する必要があります。 Webアプリの開発はPCを使って行う [...]
2021年5月23日 13:02
【Rails】Railsアプリのデバッグ《Better Errors篇》
# はじめに Railsアプリの開発中になんらかのエラーが発生すると、デフォルトでは以下のような画面が表示されます(画像をクリックすると拡大します)。 <a class="gallery" data-group="gallery" href [...]
2021年5月22日 19:42