getNavItems
(ベータ)
ナビゲーションメニューの項目を取得するには、このワイヤアダプタを使用します。
getNavItems
は、このユーザインターフェース API リソースを使用します。
-
formFactor
— (省略可能) 応答には、次のフォーム要素をサポートするナビゲーション項目が含まれます。Large
— (デフォルト) デスクトップ表示サイズ。Medium
— タブレット表示サイズ。
-
Small
— 電話表示サイズ。formFactor
として渡す値を取得するには、@salesforce/client/formFactor
モジュールを使用します。 -
navItemNames
— (省略可能) 応答に含まれる TabDefinitionname
の値のカンマ区切りリスト。navItemNames
が指定されていない場合、指定されたformFactor
のすべてのナビゲーション項目が応答に含まれます。 -
page
— (省略可能) ナビゲーション項目を返す開始点となるページのオフセット。デフォルト値は 0 で、最初のページからナビゲーション項目を返します。たとえば、page=2
で、pageSize=10
の場合、リストの 21 番目の項目から返されます。 -
pageSize
— (省略可能) ページで返されるナビゲーション項目の最大数。デフォルト値は、25 です。 -
propertyOrFunction
— ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが@wire
でデコレートされている場合、結果はそのプロパティのdata
プロパティまたはerror
プロパティに返されます。関数が@wire
でデコレートされている場合、結果はdata
プロパティとerror
プロパティを持つオブジェクトで返されます。
data
— ナビゲーション項目error
— FetchResponse