はじめに
Font Awesome 便利ですよね。インストールして HTML に記述するだけで簡単にアイコンを Web サイトで使えるようになります。
例えばこのように HTML を記述すれば
<i class="fas fa-star"></i>
キラキラ
<i class="fas fa-star"></i>
こんな風に表示されます。
このアイコンは CSS の擬似要素(::before, ::after)でも使用できるのですが、この時にアイコンが □(四角)で表示されてしまいました。今回はその対処法を記事にします。
環境
- ruby 2.6.3
- rails 6.0.0
- webpacker 4.0.7
- yarn 1.17.3
Font Awesome の導入
まずは Font Awesome を導入しましょう。
yarn でインストール
Font Awesome の公式にyarnを使用したインストールの方法が記載されているのでこちらを参考にします。
# @fo「n」tawesome ではなく@fo「r」tawesome なので注意！！！
$ yarn add @fortawesome/fontawesome-free
成功すればnode_modulesフォルダに@fortawesome/fontawesome-freeフォルダが生成されています。この中にyarnでインストールした Font Awesome のファイルが格納されています。
エントリーファイルの記述
次に Web ブラウザが読み込む js ファイル(エントリーファイル)の記述をしていきます。
app/javascripts/pack/application.jsに以下の記述を追加します。
import "@fortawesome/fontawesome-free/js/all";
import "../src/application";
application.scss の作成
先ほど
import "../src/application";
を記述したので、app/javascripts/src/application.scssを作成します。
$ mkdir app/javascripts/src
$ touch app/javascripts/src/application.scss
app/javascripts/src/application.scssに以下のコードを記述します。
@import "~@fortawesome/fontawesome-free/scss/fontawesome";
HTML のから記述した js, scss ファイルの呼び出し
app/views/layouts/application.erb.htmlの
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %> -->
というコードを
<%= stylesheet_pack_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %> -->
に変更します。
以上で導入は完了です。あとはFont Awesome の公式サイトから好きなアイコンを検索して HTML を記述していけば使えます。
問題
この方法で冒頭で紹介したような i タグでの使用はできるのですが、CSS の擬似要素で使用する際に □(四角)が表示されてしまいます。
例えば以下のようなHTMLとscssを記述した場合、
<span class="kirakira">キラキラ</span>
// class="kirakira"のテキストの最初と最後に★が追加されるコード
// application.scssの一番下に記述
.kirakira {
&::before {
font-family: "Font Awesome 5 Free";
font-weight: 900;
content: "\f005";
color: red;
}
&::after {
font-family: "Font Awesome 5 Free";
font-weight: 900;
content: "\f005";
color: blue;
}
}
このように表示されてしまいました。
contentの Unicode を間違えたのか、font-weightの値を間違えたのか、色々調べたのですが…
原因
[application.scss の作成]の項目で記述した
@import "~@fortawesome/fontawesome-free/scss/fontawesome";
というコードはnode_modulesフォルダ内の@fortawesome/fontawesome-free/scss/fontawesomeファイルを参照しています。
ドキュメントではメインのファイルであるというような紹介がされていますが、内部では同じファイル内の scss ファイルを色々と@importしています。
/*!
* Font Awesome Free 5.10.2 by @fontawesome - https://fontawesome.com
* License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
*/
@import 'variables';
@import 'mixins';
@import 'core';
@import 'larger';
@import 'fixed-width';
@import 'list';
@import 'bordered-pulled';
@import 'animated';
@import 'rotated-flipped';
@import 'stacked';
@import 'icons';
@import 'screen-reader';
上の画像とこのコードを見比べてみるとわかるのですが、
brands.scssregular.scsssolid.scss
が@importされていません。(v4-shims.scssも@importされていませんが、ここでは割愛させていただきます。)
これらのファイルは、内部で@font-faceを使ってFont Awesome 5 FreeまたはFont Awesome 5 Brandsという font-family を定義していました。
/*!
* Font Awesome Free 5.10.2 by @fontawesome - https://fontawesome.com
* License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
*/
@import 'variables';
@font-face {
font-family: 'Font Awesome 5 Free';
font-style: normal;
font-weight: 400;
font-display: $fa-font-display;
src: url('#{$fa-font-path}/fa-regular-400.eot');
src: url('#{$fa-font-path}/fa-regular-400.eot?#iefix') format('embedded-opentype'),
url('#{$fa-font-path}/fa-regular-400.woff2') format('woff2'),
url('#{$fa-font-path}/fa-regular-400.woff') format('woff'),
url('#{$fa-font-path}/fa-regular-400.ttf') format('truetype'),
url('#{$fa-font-path}/fa-regular-400.svg#fontawesome') format('svg');
}
.far {
font-family: 'Font Awesome 5 Free';
font-weight: 400;
}
これを@importすれば使えるのでは？
対処法
という訳でapplication.scssを以下のように記述します。
@import "~@fortawesome/fontawesome-free/scss/fontawesome";
// 各アイコンのスタイルの参照
@import "~@fortawesome/fontawesome-free/scss/regular";
@import "~@fortawesome/fontawesome-free/scss/solid";
@import "~@fortawesome/fontawesome-free/scss/brands";
.kirakira {
// …中略
}
すると以下のようなエラーメッセージが出てコンパイルエラーが出ました。
Module not found: Error: Can't resolve '../webfonts/fa-brands-400.eot'
../webfonts/fa-brands-400.eotなんて無いよ！と怒られたのでregular.scssのコードをもう一度よく見てみます。
/*!
* Font Awesome Free 5.10.2 by @fontawesome - https://fontawesome.com
* License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
*/
@import 'variables';
@font-face {
font-family: 'Font Awesome 5 Free';
font-style: normal;
font-weight: 400;
font-display: $fa-font-display;
src: url('#{$fa-font-path}/fa-regular-400.eot');
src: url('#{$fa-font-path}/fa-regular-400.eot?#iefix') format('embedded-opentype'),
url('#{$fa-font-path}/fa-regular-400.woff2') format('woff2'),
url('#{$fa-font-path}/fa-regular-400.woff') format('woff'),
url('#{$fa-font-path}/fa-regular-400.ttf') format('truetype'),
url('#{$fa-font-path}/fa-regular-400.svg#fontawesome') format('svg');
}
.far {
font-family: 'Font Awesome 5 Free';
font-weight: 400;
}
色々書かれていますが、@font-faceで指定されている url に$fa-font-pathという変数が使用されています。
この変数の定義元は同じフォルダ内の_variables.scssにありました。
$fa-font-path: "../webfonts" !default;
この値が../webfontsなので../webfonts/fa-brands-400.eotが url として指定されたようです。
この値を上書きすれば正しく参照されそうです！
@import "~@fortawesome/fontawesome-free/scss/fontawesome";
// @face-fontがnode_modulesフォルダにインストールされたfontawesomeのwebfontを参照するように値を変更
$fa-font-path: "~@fortawesome/fontawesome-free/webfonts";
@import "~@fortawesome/fontawesome-free/scss/regular";
@import "~@fortawesome/fontawesome-free/scss/solid";
@import "~@fortawesome/fontawesome-free/scss/brands";
.kirakira {
// …中略
}
結果はこちらです。
うまく表示されました！
まとめ
Font Awesome 5 Freeを定義しているファイルを参照していないために起きたエラーでした。
今回調べても中々同じような対処をしている記事をみつけられなかったので記事にしました。一人でも助けになれば幸いです。
しかしまあ手軽で便利ですね〜。ホント(font) Awesome。
何か直すべき点、間違った記述があればコメント等で指摘していただければと思います。