はじめに
みなさん『ハリー・ポッター』が好きですか？
僕は好きです。小さい頃はよく木の枝で奇妙な形をなぞって、どこの国の言語かもわからない呪文を唱えながら遊んでいました。特に光を出す「ルーモス」という魔法に憧れてて、それである日。。。
え？なんの話かって？
ごめんごめん、Party.jsを紹介しようとしていました。
これはWebページに「紙吹雪」や「星形がキラキラと爆ける」エフェクトを表現できるとても面白いJavaScriptのライブラリーなんです。
ユーザーがボタンなどをクリックすると発火し、フォームのSubmitボタンやお気に入りボタンに実装することで、ページ全体が華やかになり、ユーザー体験を向上させられます。
どんなエフェクトなのか、さっそく見ていきましょう。
そうですね、今の時期は冬で、冬と言えば雪ですよね。では雪の魔法使いになっていただきましょう。
See the Pen
party.js snow by Toufup (@toufup)
on CodePen.
あ。。。そこのお嬢さん、歌わなくていいですよ。
ということで本稿ではParty.jsの基本的な使い方から、少しこだわったカスタマイズ方法まで紹介していきます。これを使いこなせば、Web上で好きなものを好きなだけ生やせる魔法使いになれます。
少しだけ自己紹介をさせてください。未経験からWebエンジニアへの転職を目指しプログラミングスクールの Runteq で勉強している者です。今回紹介するParty.jsは個人開発のアプリにも使われています → K-POPコール練習アプリ | Sycall。よかったらぜひ使ってみてください〜！
また、本稿は2021 RUNTEQアドベントカレンダーに収録されています。
こんな方にぜひ読んでほしい
- サイトのユーザー体験を向上させたい
- ポートフォリオの見栄えを良くしたい
魔法使いになりたい
この記事の構成
【1、基本の使い方】：Party.jsをサクッと導入して使ってみる
【2、カスタマイズする】：色を変えたり、持続時間を変えたり、プロパティをいろいろいじってみる
【3、応用する】：さらにこだわりを！ハート型や絵文字など、好きな形にカスタマイズしてみる
0、インストール
cdn
<script src="https://cdn.jsdelivr.net/npm/party-js@latest/bundle/party.min.js"></script>
npm、yarn
npm install party-js
# or
yarn add party-js
import party from "party-js";
// or
const party = require("party-js");
1、基本の使い方
1、任意のHTML要素にクリックイベントを設定し、ハンドラにParty.jsのメソッドを使って処理を書きます。
例として<button>タグを使っていますが、<div>タグ、<a>タグももちろんOKです。
<button class="btn1">confetti</button>
<button class="btn2">sparkles</button>
2、デフォルトではconfettiとsparklesメソッドが使えます。
この2つは作者がParty.jsのモジュールを上手に組み合わせてくれたプリセットです。
confetti は紙吹雪の意味で、sparkles は輝く意味です。
第一引数にはHTMLElement、またはMouseEventのオブジェクトを、
第二引数（省略可）にはカスタマイズの設定を書きます（この後のセクションで紹介します）
document.querySelector(".btn1").addEventListener("click", function (e) {
party.confetti(this);
});
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(this);
});
codepen で確認してみましょう
See the Pen
Untitled by Toufup (@toufup)
on CodePen.
メソッドの第一引数にHTMLElementを使うのとMouseEventを使うのとでは挙動が若干変わります。
HTMLElementはボタン全体を中心にエフェクトが発生するのに対して、
MouseEventクリックした点を中心にエフェクトが発生します。
ここは好みの問題なのでどちらでも構いませんが、個人的に MouseEvent に設定したほうが望ましい挙動になります。
document.querySelector(".btn1").addEventListener("click", function (e) {
// ボタン全体を中心にエフェクトが発生
party.confetti(this);
});
document.querySelector(".btn2").addEventListener("click", function (e) {
// クリックした点を中心にエフェクトが発生
party.sparkles(e);
});
2、カスタマイズする
sparklesをカスタマイズする方法を紹介していきます。confettiについては公式Docを参照してください。まあプロパティが大体同じなので通用できると思います。
先ほど言及したように、カスタマイズするためのオプションは sparkles や confetti の第二引数に、オブジェクトの形で指定してあげます。
なお、便宜のためここでは confetti の紙屑、 sparkles の星形のことを「粒子」と呼ぶことにします。
lifetime：粒子の持続時間
lifetime: party.variation.range(最小持続時間[秒], 最大持続時間[秒])
party.variation.range()は指定された範囲内の時間をランダムに生成する関数を返します。なので、粒子の一つひとつが異なる持続時間を持ちます。
全部同じ持続時間にしたければ、固定の数値を渡せばいいです。
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// 2〜4秒持続します（粒子ごとに異なります）
lifetime: party.variation.range(2, 4),
// 5秒持続します
// lifetime: 5,
});
});
count：粒子の数
count: party.variation.range(最小個数, 最大個数)
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// 粒子の数は10〜20個（イベント発火するたびに変化します）
count: party.variation.range(10, 20),
// 固定で10個生成します
// count: 5,
});
});
speed：粒子が拡散していく速度
speed: party.variation.range(最小速度, 最大速度)
単位不明ですがおそらくピクセル/1秒 だと思います。
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// 速度100〜200で拡散していきます。（粒子ごとに異なります）
speed: party.variation.range(100, 200),
// 固定で速度10で拡散していきます。
// speed: 10,
});
});
size：粒子の初期の大きさ
size: party.variation.range(最小倍率, 最大倍率)
単位不明ですがおそらくソース粒子の何倍 だと思います。
ソース粒子の大きさはあらかじめ決まっているため、デフォルトの sparkles と confetti メソッドにおいては変更できません。
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// ソース粒子の1〜3倍（粒子ごとに異なります）
size: party.variation.range(1, 3),
// 固定でソース粒子の10倍。
// size: 10,
});
});
rotation：粒子の初期の角度
rotation: () => new party.Vector(x軸, y軸, z軸)
x軸, y軸を変更するシーンはあまりないと思います。使い方としてはz軸をランダムに変化させるか、固定の値にするかぐらいです。（どちらにせよ粒子がぐるぐる回転し出すと角度なんて気にならないので。。。）
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// 初期の角度が0~360度（粒子ごとに異なります）
rotation: () => new party.Vector(0, 0, party.random.randomRange(0, 360))
// 固定で90度
// rotation: () => new party.Vector(0, 0, 90),
});
});
color：粒子の初期の色
color: () => party.Color.fromHsl(h, s, l)
h, s, lの値はparty.random.randomRange(最小値, 最大値)を使って動的に変化できます。
または
color: party.Color.fromHex(カラーコード)（#66ccff みたいなコードのことです）
注意：粒子ごとに色を変化させたい場合は関数をreturnしてあげます。固定の値の場合メソッドの戻り値だけ渡せばOKです。
document.querySelector(".btn2").addEventListener("click", function (e) {
party.sparkles(e,{
// 初期の色が緑（粒子ごとに明度が異なります）
color: () => party.Color.fromHsl(150, 100, party.random.randomRange(50, 85))
// 固定で90度
// rotation: new party.Vector(0, 0, 90),
});
});
3、応用する
3-1、星をハート型に変える
魔法使いたるものは星形だけに満足してはいけません。今度はハート型の sparkles エフェクトを作ってみましょう。
See the Pen
party.js hearts by Toufup (@toufup)
on CodePen.
と言っても、実は公式のドキュメントにこの作り方とコードが載っているんです。"Hearts" Demo
コピペすればすぐに使えるんですが、それだけだと今後応用できないので、少しコードを読んでみます。
下記の部分がハート型を作るコードですが、どうやらDocument.createElementNS()を使って SVGElement を作成しているようです。SVG は図形をコードで表現できるものです。4行目の"M316.722,29.....なんとかのコードがハート型を描くためのコードです。
const heartPath = document.createElementNS("http://www.w3.org/2000/svg", "path");
heartPath.setAttribute(
"d",
"M316.722,29.761c66.852,0,121.053,54.202,121.053,121.041c0,110.478-218.893,257.212-218.893,257.212S0,266.569,0,150.801 C0,67.584,54.202,29.761,121.041,29.761c40.262,0,75.827,19.745,97.841,49.976C240.899,49.506,276.47,29.761,316.722,29.761z"
);
const heartShape = document.createElementNS("http://www.w3.org/2000/svg", "svg");
heartShape.setAttribute("viewBox", "0 0 512 512");
heartShape.setAttribute("height", "20");
heartShape.setAttribute("width", "20");
heartShape.appendChild(heartPath);
そして出来上がった SVGElement（変数 heartShape のこと）を shapeFactory で指定します。すると粒子がハート型に変身します。
rendererOptions: {
shapeFactory: heartShape,
applyLighting: undefined,
},
ここでひとつ思ったのですが、SVGElement を描くためのコードを変えれば、もっといろんな形にできるのでは？例えば記事冒頭の雪印の図形。
しかし、その長い長い"M316.722,29.....なんとかのコードは一体どうやって書くのでしょうか？
実は FontAwesome や MaterialDesignIcons などのサイトで見つけることができます。
FontAwesome だとちょっと面倒で、一度SVGファイルをダウンロードしてからファイルのソースコードから漁ってくるか、↓
または開発者ツールでアイコンのコードから取ってきます。↓
MaterialDesignIcons では View SVGというメニューから簡単に見ることができます。
この部分を先ほどの"M316.722,29.....なんとかのコードに置き換えれば任意の図形にカスタマイズすることができます！！
3-2、絵文字もいける
みんなの大好きな絵文字ももちろん粒子として使えます！
See the Pen
party.js money by Toufup (@toufup)
on CodePen.
ポイントはdocument.createElementで要素を作り絵文字をinnerTextで入れることです。
const moneyElement = document.createElement("span")
moneyElement.innerText = "🥟"
//（省略）
rendererOptions: {
shapeFactory: gyouzaElement,
applyLighting: undefined,
}
同じ理論で自前のPNG画像を粒子として指定することもできると思います。興味ある方はぜひ試してみてください。
3-3、あるいはこんなこと。。。
See the Pen party.js gyouza by Toufup (@toufup) on CodePen.
www いろいろ遊んでみてください
おわりに
いかがだったでしょうか？Party.jsを上手に使えば、Webページに躍動感や華やかさをもたらすことができます。
しかし、何でもかんでもエフェクトを出してしまうと逆に鬱陶しくなったりもするので、「ここぞ！」というところにだけ使用した方が良いかと思います。
参考
https://party.js.org/
https://github.com/yiliansource/party-js