‘Vue.js’ タグのアーカイブ

murave

Framework7 Vue を調査する

以前の記事『Framework7のrouter.backで戻っても最新データに更新したい』でいろいろと調べてたときの手法をまとめてみるなど。

情報収集からデバッグ手法まで雑多なので曖昧な「調査する」というタイトルにしてみました。

そうそう、せっかくなので本家(https://framework7.io/)のスポンサーのところをキャプチャして貼っときますね。弊社が載ってます。

この記事にもスポンサーが更新されてない日本語サイト(https://framework7.jp/)しかでてこなかったりしますし、少しは主張を。

Framework7 Vue の事情

Framework7は決して薄くないフレームワークなのでFramework7側を調べたほうが良いことが多いと思います。もちろんVueの知識も必要になりますが(ちなみに今回はVueといったらVue3を指していると思ってください)

Framework7側の事情でVueでの一般的な書式と少し違う書き方を求められる事などもありますので注意しましょう。

なにはともあれ公式ドキュメントを読もう

Framework7もVueも日本語化された公式ドキュメントが充実しているのでまずはこれらをみましょう。必要情報を探すのもそうですが定期的に繰り返し全体を見返す位がいいと思います。よく「以前探してて見つからなかったヤツだ!出来たんかい!」とかなります。

Framework7の日本語化された公式ドキュメントは 日本語サイトのトップ(https://framework7.jp/)からたどることができます。

Framework7 Vue (https://framework7.jp/vue/)

前述の「Framework7側の事情でちょっと変わった書き方を求められる」などの情報は Framework7 Vue のドキュメントに情報があります。逆に「Framework7では簡単にできてたのにVueと組み合わせた場合にどうやったらいいかわからん!」といった場合もここのどこかに情報が埋まっていることが多いです。例えば

「あれ? v-model じゃだめなん?」

入力/フォーム要素 Vueコンポーネント(https://framework7.jp/vue/inputs.html)に以下の記述があります。気づかないとハマります。

f7-list-inputとf7-inputのVueコンポーネントは、valueのpropにv-modelをサポートしています。

<template>
<p>Name is {{ name }}</p>
<p>Email is {{ email }}</p>
...
<f7-list-input
label="Name"
type="text"
placeholder="Your name"
clear-button
v-model:value="name"
/>

<f7-input
type="text"
placeholder="Your email"
clear-button
v-model:value="email"
/>
...
</template>
<script>
export default {
data() {
name: '',
email: '',
},
...
};
</script>
「Framework7のrouter、簡単に取得できないん?」Vueコンポーネントの拡張機能(https://framework7.jp/vue/vue-component-extensions.html)に情報がありました。

ルーターのインスタンスと現在のルートは、ルーターコンポーネントにpropsを介して渡されます。

<template>
...
</template>
<script>
export default {
// コンポーネントが受け取れるようにpropsを定義します。
props: {
f7route: Object,
f7router: Object,
},
...
mounted() {
console.log(this.f7route.url)
},
methods: {
navigate() {
this.f7router.navigate('/some-page/')
}
}
};
</script>
これ、気づくまでかなり困ってました。

Framework7 Core (https://framework7.jp/docs/)

Framework7自体のドキュメントです。Framework7 Vue のドキュメントだけでなくこちらについても読んだり情報を探したりすると良いです。以前の記事に書いたpage:reinit(pageReinit)イベントはこちらで見つけました。

まぁ、後で確認したらFramework7 Vueの方にも載ってたんですが(https://framework7.jp/vue/page.html)

どちらかというとpageのイベントということでなかなか気づかなかったんですよね。router調べてたので。

Vue.js devtools が便利すぎる

以前はVue3の場合beta版を使用する必要がありましたが、現在のバージョン(6.1.4)はVue3に対応しています。
ともかく便利なので使おう! というか、ないとやってられない。

私はChrome拡張のを使ってます。
https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd?hl=ja

前述のpropsで受け取ったf7routerを覗いて構造やヒストリーを確認したりもできます。最高!

ソースコードを読んだりもする

router.backとrouter.navigateの動作を調べていた際はソースコードを読んでrouter.backがrouter.navigateにわたすオプションと追加処理の組み合わせで実現されているのを確認して「ヒストリー直接弄れそうなのでどうにかなるな」と思ったりしました。

ちょっと試して「これ全部navigateで書き直すのと変わらんのでは」と思い直して別の手段がないか調査に戻りましたが。

なんだかんだで console.log

「本当にこの処理通ってる?」とか「処理の順番どうなってる?」とか、なんだかんだでconsole.logしちゃうのが手っ取り早いですね。

結局は?

いろいろと試した末に「こういうイベントがあるといいんだけどなぁ」と思いつつ公式ドキュメントを頭から読み直してたら使えそうなイベントが見つかったのでした。

そんで console.log で動きを確かめて「使える! ひゃっほー!」となりましたとさ。

murave

Framework7のrouter.backで戻っても最新データに更新したい

関係の技術記事書こうかと思ったんだけど、リタイアしたのでこれだけ書いとこうかと
— murave (@murave) March 30, 2022

昨日はリタイアしたけど、今日はがんばる。

日本語サイト(https://framework7.jp/)から引用すると

Framework7 – は、ネイティブなルック&フィールを持つモバイル、デスクトップ、またはウェブアプリケーションを開発するためのフリーでオープンソースのフレームワークです。また、必要に応じてアプリのプロトタイプをすぐに表示できる、不可欠なプロトタイピングツールでもあります。

といったものです。

弊社の場合、まずはプロトタイプ作成に使用され「Vue3対応してるしアプリ開発もそのままいこうぜ」といった流れだった気がします(確かそのタイミングでスポンサーになった)

使ってみた感じフルスタックなフレームワークという印象で、Vue.js、React、Svelteのコンポーネントもあってエライです。前述のとおり弊社では Framework7 Vue + Vue3 を採用しています。

さて、本題。Framework7は独自のrouterをもっています。今回は関係ないですが独自のstoreも持ってます。あふれるフルスタック感。

routerに話を戻すと、特定条件下ではヒストリーをもたせることができ、router.backでヒストリーにキャッシュされた前のページに戻るとことができます。便利な機能です。特にモック段階では。

モックを元に本番実装を進めていたある日、はたと困りました。

「router.backして戻った先の表示データを最新に更新したいけど、どうしよう」

もちろん普通に遷移(router.navigate)させてサーバーからデータを再取得させるのは可能です。しかしそれをやると戻ったつもりがヒストリーに積まれてしまい戻り先でさらに「戻る」(router.back)させたときに挙動が想定からはずれてしまいます。

『トップ』から『リスト画面』を開き『詳細画面』に遷移したのちに戻ったとすると

『トップ』 -navigate-> 『リスト画面』 -navigate-> 『詳細画面』 –back-> 『リスト画面』 -back-> 『トップ』

となってほしいところが

『トップ』 -navigate-> 『リスト画面』 -navigate-> 『詳細画面』 –navigate-> 『リスト画面』 -back-> 『詳細画面』

となってしまうわけです(変更したbackとnavigateに下線つけてます)

すべてnavigateにしてアプリ側でコントロールする、というのは避けたいところなのでいろいろと調査・検討しました。

ヒストリー弄ってみたりといろいろと試してたんですがありましたよ「これだ!」というイベントが。それはpage:reinit(pageReinit)。日本語サイトのページ(https://framework7.jp/docs/page.html)から引用します。

このイベントは、すでに初期化されたページに移動した場合に発生します。

前に挙げた遷移の例だと、『リスト画面』から『詳細画面』への遷移(navigate)する際にこのイベントでサーバーからのデータ取得を行うように仕込んでおけば『詳細画面』から戻る(back)した際にデータの再取得がおこなわれます。

router.onceで一度だけイベント処理を行うという設定が可能なので疑似コードは以下のようになります(Framework7 Vue + Vue3の場合)

const props = defineProps({
f7router: Object,
});
const { f7router } = props;

const 詳細画面に遷移 = () => {
f7router.once('pageReinit', async (pageData) => {
await データ取得();
});
f7router.navigate('/詳細画面/');
}
リスト画面でデータ取得のために指定されたパラメータは残っていますので利用者が意図した条件のまま最新データに更新されます。

murave

Vuexのモジュールから他のモジュールのメソッドを呼ぶには

muraveです。ごぶさたしております。

Nuxt.jsとかVue.jsの小ネタをまとめて書こうと思ったのですが、これは分けておいたほうがいいかな?と思ったので先に書いておきます。

Vuexのモジュールによる名前空間は処理を分割管理するのに便利です。

モジュール | Vuex

ですが、他のモジュールのメソッド(action, mutation)を呼ぶことができない(と思っていた)ので、不便に感じつつルートであるindex.jsに共通処理を集めたりなどしていました。が、先日、呼び出し方法に気づきました。

前掲のモジュールのドキュメントにあるように名前空間内で普通にdispatchやcommitを使うと同一名前空間のaction、 mutationが実行されます。

rootオプションがあり、これを渡すことでルートのものを呼ぶこともできます。

ドキュメントのサンプルコードから抜粋して引用します。

modules: {
foo: {
namespaced: true,

actions: {
// ディスパッチとコミットもこのモジュール用にローカライズされています
// ルートディスパッチ/コミットの `root` オプションを受け入れます
someAction ({ dispatch, commit, getters, rootGetters }) {
dispatch('someOtherAction') // -> 'foo/someOtherAction'
dispatch('someOtherAction', null, { root: true }) // -> 'someOtherAction'

commit('someMutation') // -> 'foo/someMutation'
commit('someMutation', null, { root: true }) // -> 'someMutation'
},
}
}
}
私はこのサンプルを見て、モジュールからは同一名前空間内か「ルートのみにアクセス」可能と思いこんだのですが…

そう、「ルートからのアクセス」が可能なのです。他のモジュール(例えばbar)から前記のfoo内のsomeActionを呼ぶ場合、次のように書けばよかったのです。

modules: {
bar: {
namespaced: true,

actions: {
someAction ({ dispatch, commit, getters, rootGetters }) {
dispatch('foo/someOtherAction', null, { root: true }) // -> 'foo/someOtherAction'
},
}
}
}
Vuexを使い始めて1年以上経過しての気づきでした(;´Д`)