內容片段選擇器 — 相關屬性

最後更新： 2025年4月2日

建立對象：

  • 管理員
  • 使用者

微前端內容片段選擇器可讓您瀏覽或搜尋存放庫中的內容片段，並在您的應用程式中使用這些片段。

您可以使用以下屬性來自訂內容片段選擇器的呈現方式及其使用方式：

內容片段選擇器屬性

屬性類型必要預設說明
imsToken字串否用於驗證的IMS權杖。
repoId字串否用於驗證的存放庫ID。
orgId字串是用於驗證的組織ID。
locale字串否地區設定資料。
env環境否內容片段選擇器部署環境。
filtersFragmentfilter否要套用於內容片段清單的篩選器。 依預設，/content/dam下的片段將會顯示。 預設值： { folder: "/content/dam" }
isOpen布林值是false此旗標可觸發開啟或關閉選取器。
onDismiss() =>無效是選取​ 解除 ​時要呼叫的函式。
onSubmit({ contentFragments： {id: string, path: string}[]， domainNames： string[] }) => void是

選取一或多個內容片段後使用​ Select ​時要呼叫的函式。

函式將接收：

  • 具有id和path欄位的所選內容片段
  • 與存放庫的計畫識別碼和環境識別碼相關的網域名稱，其狀態為ready和tier發佈

如果沒有網域名稱，則會使用Publish執行個體做為遞補網域。

theme"light"或"dark"否內容片段選擇器的主題。 預設主題已設定為UnifiedShell環境的主題。
selectionType「單一」或「多個」否single可用來限制FragmentSelector選取範圍的選取型別。
dialogSize"fullscreen"或"fullscreenTakeover"否fullscreen控制對話方塊大小的選用屬性。
waitForImsToken布林值否false表示內容片段選擇器是否在SUSI流程的內容中呈現，且需要等待imsToken準備就緒。
imsAuthInfoImsAuthInfo否包含登入使用者的IMS驗證資訊的物件。
runningInUnifiedShell布林值否指出內容片段選擇器是在UnifiedShell下執行，還是獨立執行。
readonlyFiltersResourceReadonlyFiltersField否可應用於內容清單且無法移除的唯讀篩選器。

ImsAuthProps屬性

ImsAuthProps屬性定義內容片段選擇器用來取得imsToken的驗證資訊和流程。 藉由設定這些屬性，您可以控制驗證流程應該如何行為並註冊各種驗證事件的接聽程式。

屬性名稱描述
imsClientId代表用於驗證目的之IMS使用者端ID的字串值。 此值由Adobe提供，且為您的Adobe AEM CS組織專用。
imsScope說明用於驗證的範圍。 範圍會決定應用程式對貴組織資源的存取層級。 多個範圍可以用逗號分隔。
redirectUrl代表驗證後重新導向使用者的URL。 此值通常設定為應用程式目前的URL。 如果未提供redirectUrl，ImsAuthService將使用用來登入imsClientId的redirectUrl
modalMode表示驗證流程是否應該顯示在強制回應視窗（快顯視窗）中的布林值。 如果設為true，驗證流程會以快顯視窗顯示。 如果設為false，則驗證流程會以全頁重新載入顯示。
注意： ​若要獲得較好的UX，您可以在使用者停用瀏覽器快顯視窗時動態控制此值。
onImsServiceInitializedAdobe IMS驗證服務初始化時呼叫的回呼函式。 此函式接受一個引數service，此引數是代表Adobe IMS服務的物件。 如需詳細資訊，請參閱ImsAuthService。
onAccessTokenReceived從Adobe IMS驗證服務收到imsToken時所呼叫的回呼函式。 此函式接受一個引數imsToken，該引數是代表存取權杖的字串。
onAccessTokenExpired當存取權杖過期時所呼叫的回呼函式。 此函式通常用於觸發新的驗證流程，以取得新的存取權杖。
onErrorReceived驗證期間發生錯誤時所呼叫的回呼函式。 此函式採用兩個引數：錯誤型別和錯誤訊息。 錯誤型別是代表錯誤型別的字串，而錯誤訊息是代表錯誤訊息的字串。