API バージョン設定

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

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

Salesforce プラットフォームの LWC は、LWC オープンソースと同じコードベースを使用していますが、Salesforce プラットフォーム上の LWC のバージョンは、オープンソースのバージョンより 3 ～ 6 か月程度遅れています。LWC オープンソースは、セマンティックバージョニング (semver) の仕様に準拠しています。_LWC オープンソース_の「LWC Versioning (LWC バージョン管理)」を参照してください。

Tip

コンポーネントの API バージョンのアップグレード

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

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

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

Note

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <apiVersion>58.0</apiVersion>
4</LightningComponentBundle>

たとえば、apiVersion の値を 58.0 に指定すると、コンポーネントは引き続き API バージョン 58.0 (Summer ‘23) での動作と同じ動作をします。

コンポーネントレベルの大幅な変更

コンポーネントレベルの大幅な変更が、Lightning Experience およびエクスペリエンスビルダーサイトのカスタムコンポーネントに適用されます。この変更をコンポーネントに実装するには、apiVersion を 59.0 にアップグレードします。

コンポーネントレベルの機能

Winter ‘24 では、apiVersion の値に対応する LWC の新しい機能はありません。Salesforce の最新リリースで apiVersion の値に適用される LWC のすべて変更点については、リリースノートを参照してください。

Salesforce のリリースと LWC API のバージョン

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

Salesforce リリース	LWC API バージョン
Summer ‘23	58.0
Winter ‘24	59.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 または Experience Cloud で実行されていない場合、最新の LWC API バージョンを使用します。
同じページまたは同じ管理パッケージ内にあるコンポーネントには、異なる API バージョンを設定できます。

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。