API バージョン設定

使用可能な API バージョン
API v59.0 以降で使用できます。

Winter ' 24 より、LWC ではカスタムコンポーネントのバージョン設定がサポートされます。コンポーネントでバージョンを指定すると、そのコンポーネントは Salesforce リリースの特定のバージョンに連動します。コンポーネントのすべての HTML、CSS、JS ファイルは、1 つの API バージョンに対応しています。API バージョンは、コンポーネントの指定された API バージョンに対応する Salesforce リリースの動作と同じ動作をするように LWC フレームワークへ指定するものです。

LWC オープンソースは、セマンティックバージョニング (semver) の仕様に準拠しています。_LWC オープンソース_の「LWC Versioning (LWC バージョン管理)」を参照してください。

Salesforce プラットフォームの LWC は、LWC オープンソースと同じコードベースを使用していますが、Salesforce プラットフォーム上の LWC のバージョンは、オープンソースのバージョンより 3 ~ 6 か月程度遅れています。たとえば、LWC OSS は 2023 年 6 月に v3.0.0 がリリースされましたが、外部の Salesforce プラットフォーム開発者が使用できるようになったのは Winter '24 のリリースからでした。

Winter '24 の時点で、58.0 以前の API バージョンはすべて 58.0 (Summer '23) に対応しています。API バージョンを 58.0 より低い値に設定した場合、LWC ではデフォルトでバージョン 58.0 が使用されます。

新しい API バージョンに関連するバグ修正や新機能を適用するには、コンポーネントの API バージョンをアップグレードしてください。

ある API バージョンの警告は、次の API バージョンではエラーになる可能性があります。バージョンごとにテストをして、1 バージョンずつアップグレードすることをお勧めします。

コンポーネントの API バージョンをアップグレードする手順は、次のとおりです。

  1. コンポーネントを公開します。SFDX コンソールの警告をすべて修正します。
  2. Sandbox でコンポーネントを実行します。ブラウザーの DevTools コンソールで、すべての警告を修正します。
  3. コンポーネントの *.js-meta.xml ファイルの apiVersion を次のバージョンに増分します。
  4. コンポーネントを再度公開し、警告が表示されなくなったことを確認します。

たとえば、apiVersion の値を 58.0 に指定すると、コンポーネントは引き続き API バージョン 58.0 (Summer '23) での動作と同じ動作をします。コンポーネントには、バージョン 59.0 以降で導入されたバグ修正や機能強化は含まれません。

apiVersion に関係なく、カスタムコンポーネントは常に最新バージョンの Lightning データサービスと Lightning 基本コンポーネントを使用します。

コンポーネントレベルの大幅な変更が、Lightning Experience、エクスペリエンスビルダーサイト、および Salesforce モバイルアプリケーションのカスタムコンポーネントに適用されます。

Salesforce プラットフォームの外部で LWC を使用する LWC 開発者は、他の破壊的変更の影響を受けます。詳細は、LWC OSS v4.0.0 を参照してください。

Winter '24 では、apiVersion の値に対応する LWC の新しい機能はありません。Salesforce の最新リリースで LWC に加えられたすべて変更点については、リリースノートを参照してください。特に指定のない限り、すべての変更が apiVersion の値に適用されます。

次に Salesforce のリリースと LWC API および LWC OSS のバージョンの対応付けを示します。

Salesforce リリースLWC API バージョンLWC OSS
Summer '2358.0v2.50.0 以前
Winter '2459.0v3.0.0
Spring '2460.0*v5.0.0

*LWC API バージョン 60.0 には、LWC OSS v4.0.0 の変更も含まれます。

LWC API のバージョン設定を行う際には、次のガイドラインに留意してください。

  • 既知の最も古い LWC API バージョンよりも古い apiVersion を使用している場合、LWC は既知の最も古いバージョンを使用します。たとえば、既知の最も古いバージョンが 58.0 の場合に 57.0 を指定すると、LWC は 58.0 を使用します。
  • たとえば、最新の LWC のバージョンが 60.0 の場合に 61.0 を指定すると、LWC は 60.0 を使用します。
  • LWC API のバージョン設定は、Aura コンポーネントと LWR では利用できません。
  • LWC API のバージョン設定は、*.js-meta.xml ファイルを含む Lightning Experience またはエクスペリエンスビルダーサイトのカスタムコンポーネントでのみ利用できます。
  • LWR のカスタムコンポーネントは、Lightning Experience またはエクスペリエンスビルダーサイトで実行されていない場合、最新の LWC API バージョンを使用します。
  • 同じページまたは同じ管理パッケージ内にあるコンポーネントには、異なる API バージョンを設定できます。