記事のサマリー(TL;DR)
- Shopifyの「Polaris Web Components 2.0」が、Polaris CDNの安定チャンネルで利用可能になりました。CDNのセマンティックバージョニングモデルの下での初めてのメジャーリリースです。
- Polaris 2.0は、新しいフレーム・新しいナビゲーション・新しい外観を備えた、再設計後のShopify管理画面に対応しています。
- Polaris 2.0は既存アプリに自動適用されません。
polaris.jsとpolaris-1.jsは引き続きPolaris 1.1を配信し、polaris.jsが2.x系に移行することはないため、利用には明示的な設定変更が必要です。
利用条件・移行に必要な操作
Polaris 2.0へ切り替えるには、スクリプトタグをpolaris-2.jsに変更する必要があります。
React Routerテンプレートから構築されたアプリの場合は、以下の対応が必要です。
AppProviderとshopifyAppのサーバー設定の両方でpolarisUrlを設定し、両者の値を一致させる。- この対応には
@shopify/shopify-app-react-routerのバージョン2.1.0以降が必要です。
TypeScriptを使用している場合は、@shopify/polaris-types@^2.0.0のインストールが必要です。
今後2.x系の新しいリリースが提供された際にもPolaris 2.0のバージョンに留めたい場合は、polaris-2.0.jsを参照するように固定します。
詳細
Polaris 2.0の安定版提供について
Polaris Web Components 2.0が、Polaris CDNの安定チャンネルで利用可能になりました。これは、CDNのセマンティックバージョニングモデルの下での最初のメジャーリリースです。Polaris 2.0は、新しいフレーム・新しいナビゲーション・新しい外観を持つ、再設計後のShopify管理画面に対応しています。
以下のURLが、現在Polaris 2.0を配信しています。
[コードは原文をご参照ください]
既存アプリへの影響と移行方法
Polaris 2.0は自動的にアプリへ反映されるものではありません。polaris.jsとpolaris-1.jsは引き続きPolaris 1.1を配信し続け、polaris.jsが2.x系へ移行することはありません。更新するには、スクリプトタグをpolaris-2.jsに変更する必要があります。
React Routerテンプレートから構築されたアプリでは、AppProviderとshopifyAppのサーバー設定の両方でpolarisUrlを設定し、両方の値を同じにする必要があります。この対応には@shopify/shopify-app-react-routerバージョン2.1.0以降が必要です。
TypeScriptを利用している場合は、@shopify/polaris-types@^2.0.0をインストールする必要があります。
今後2.x系の後続リリースが提供された際にもPolaris 2.0のバージョンにアプリを留めておきたい場合は、以下のようにpolaris-2.0.jsへ固定します。
[コードは原文をご参照ください]
関連ドキュメントとして、「Update your app for Polaris 2」「Versioning for web components」「Polaris web components」が案内されています。