記事のサマリー(TL;DR)
- API version 2027-01以降、顧客アカウント全画面拡張機能において、Navigation APIのcurrententrychangeイベントが設定するevent.fromの値が、遷移先のページから遷移元のページへと変更されます。
- event.fromから新しいページを読み取っている顧客アカウント全画面拡張機能にとっては破壊的変更となり、2027-01へ移行する前にshopify.navigation.currentEntryを読み取るようコードを更新する必要があります。
- 更新後のコードはAPI version 2025-10以降で動作するため、API versionの更新前にコード変更を行うことができます。
対象と移行前の条件
この変更は、customer-account.page.renderおよびcustomer-account.order.page.renderを含む顧客アカウント全画面拡張機能のうち、API version 2027-01以降でevent.fromを使って顧客の遷移先ページを特定しているものが対象です。API version 2026-10以前の拡張機能は、挙動が変わらないため影響を受けません。また、useNavigationCurrentEntryフックを含め、shopify.navigation.currentEntryを読み取っている拡張機能は、バージョンを問わず影響を受けません。
拡張機能を2027-01へ更新する前に、event.fromから新しいページを読み取っているすべてのcurrententrychangeハンドラーを更新する必要があります。更新後は、拡張機能内の2つのルート間を遷移し、各ナビゲーションで遷移先のページが表示されることを確認することが求められています。
詳細
変更内容
顧客アカウント全画面拡張機能(customer-account.page.renderおよびcustomer-account.order.page.render)において、currententrychangeはNavigationCurrentEntryChangeEventを渡します。このイベントのfromプロパティは、仕様上「直前の履歴エントリ(previous history entry)」として文書化されています。
- API version 2026-10以前:fromは新しいエントリを返します。これはshopify.navigation.currentEntryと同じ値です。
- API version 2027-01以降:fromは直前のエントリを返します。
破壊的変更と移行方法
2027-01では、event.from.urlから新しいページを読み取るコードは、代わりに直前のページのURLを取得することになります。例えば、event.fromに基づいてどのルートを表示するかを決定している拡張機能は、各ナビゲーションの後も直前のルートを表示し続けることになります。
こうした箇所は、shopify.navigation.currentEntry.urlを読み取るコードに置き換える必要があります。
変更前:
shopify.navigation.addEventListener('currententrychange', (event) => {
setPath(new URL(event.from.url).pathname);
});
変更後:
shopify.navigation.addEventListener('currententrychange', () => {
setPath(new URL(shopify.navigation.currentEntry.url).pathname);
});
更新後のコードはAPI version 2025-10以降で動作するため、API versionを更新する前にこの変更を加えることができます。
必要な対応
顧客アカウント全画面拡張機能を2027-01に更新する前に、event.fromから新しいページを読み取っているすべてのcurrententrychangeハンドラーを更新してください。更新の確認には、拡張機能内の2つのルート間を遷移し、各ナビゲーションで遷移先のページが表示されることをチェックします。
関連ドキュメント
顧客アカウントUI拡張機能向けのNavigation APIリファレンス