DocumentationAEM as a Cloud ServiceUser Guide

Content Fragment Selector - Related Properties content-fragment-selector-related-properties

Last update: Fri Dec 19 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • Admin
  • User

The Micro-Frontend Content Fragment Selector allows you to browse or search Content Fragments in the repository, and use them in your application.

You can use the following properties to customize how the Content Fragment Selector is rendered and how it can be used:

Content Fragment Selector Properties content-fragment-selector-properties

Property
Type
Required
Default
Description
ref
FragmentSelectorRef
Reference to the ContentFragmentSelector instance, allowing access to provided functionality such as reload.
imsToken
string
No
IMS token used for authentication. If not provided, the IMS login flow will be initiated.
repoId
string
No
Repository ID used for the Fragment Selector. When provided, the selector automatically connects to the specified repository, and the repository dropdown is hidden. If not provided, the user can select a repository from the list of available repositories they have access to.
defaultRepoId
string
No
Repository ID that will be selected by default when the repository selector is shown. Used only when repoId is not provided. If repoId is set, the repository selector is hidden, and this value is ignored.
orgId
string
No
Organization ID used for authentication. If not provided, the user can select a repository from different organizations they have access to. If the user does not have access to any repository or organization, the content will not be loaded.
locale
string
No
en-US
Locale.
env
string
No
Deployment environment. See the Env type for allowed environment names.
filters
FragmentFilter
No
{ folder: "/content/dam" }
Filters to be applied to the list of content fragments. By default, fragments under /content/dam will be displayed.
isOpen
boolean
No
false
Flag to control whether the selector is open or closed.
noWrap
boolean
No
false
Determines whether the Fragment Selector is rendered without a wrapping dialog. When set to true, the Fragment Selector is embedded directly in the parent container. Useful for integrating the selector into custom layouts or workflows.
onSelectionChange
({ contentFragments: ContentFragmentSelection, domainName?: string, tenantInfo?: string, repoId?: string, deliveryRepos?: DeliveryRepository[] }) => void
No
Callback function triggered whenever the selection of content fragments changes. Provides the currently selected fragments, domain name, tenant info, repository ID, and delivery repositories.
onDismiss
() => void
No
Callback function triggered when the dismiss action is performed; for example, closing the selector.
onSubmit
({ contentFragments: ContentFragmentSelection, domainName?: string, tenantInfo?: string, repoId?: string, deliveryRepos?: DeliveryRepository[] }) => void
No
Callback function triggered when the user confirms their selection. Receives the selected content fragments, domain name, tenant info, repository ID, and delivery repositories.
theme
“light” or “dark”
No
Theme for the Fragment Selector. By default, it is set to the unifiedShell environment theme.
selectionType
“single” or “multiple”
No
single
Selection type can be used to restrict selection for the Fragment Selector.
dialogSize
“fullscreen” or “fullscreenTakeover”
No
fullscreen
Optional prop to control the dialog size.
runningInUnifiedShell
boolean
No
Whether DestinationSelector is running under UnifiedShell or standalone.
readonlyFilters
ResourceReadonlyFiltersField[]
No
Read-only filters applied to the list of content fragments. These filters cannot be removed by the user.
selectedFragments
ContentFragmentIdentifier[]
No
[]
Initial selection of content fragments to be pre-selected when the selector opens.
hipaaEnabled
boolean
No
false
Indicates whether HIPAA compliance is enabled.
inventoryView
InventoryViewType
No
table
Inventory default view type to be used in the selector.
inventoryViewToggleEnabled
boolean
No
false
Indicates whether the inventory view toggle is enabled, allowing the user to switch between table and grid views.

ImsAuthProps Properties imsauthprops-properties

The ImsAuthProps properties define the authentication information and flow that the Content Fragment Selector uses to obtain an imsToken. By setting these properties, you can control how the authentication flow should behave and register listeners for various authentication events.

Property Name
Description
imsClientId
A string value representing the IMS client ID used for authentication purposes. This value is provided by Adobe and is specific to your Adobe AEM CS organization.
imsScope
Describes the scopes used in authentication. The scopes determine the level of access that the application has to your organization resources. Multiple scopes can be separated by commas.
redirectUrl
Represents the URL where the user is redirected after authentication. This value is typically set to the current URL of the application. If a redirectUrl is not supplied, ImsAuthService will use the redirectUrl used to register the imsClientId
modalMode
A boolean indicating whether the authentication flow should be displayed in a modal (pop-up) or not. If set to true, the authentication flow is displayed in a pop-up. If set to false, the authentication flow is displayed in a full page reload.
Note: for better UX, you can dynamically control this value if the user has browser pop-up disabled.
onImsServiceInitialized
A callback function that is called when the Adobe IMS authentication service is initialized. This function takes one parameter, service, which is an object representing the Adobe IMS service. See ImsAuthService for more details.
onAccessTokenReceived
A callback function that is called when an imsToken is received from the Adobe IMS authentication service. This function takes one parameter, imsToken, which is a string representing the access token.
onAccessTokenExpired
A callback function that is called when an access token has expired. This function is typically used to trigger a new authentication flow to obtain a new access token.
onErrorReceived
A callback function that is called when an error occurs during authentication. This function takes two parameters: the error type and error message. The error type is a string representing the type of error and the error message is a string representing the error message.

ImsAuthService Properties imsauthservice-properties

The ImsAuthService class handles the authentication flow for the Content Fragment Selector. It is responsible for obtaining an imsToken from the Adobe IMS authentication service. The imsToken is used to authenticate the user and authorize access to the Adobe Experience Manager (AEM) CS repository. ImsAuthService uses the ImsAuthProps properties to control the authentication flow and register listeners for various authentication events. You can use the convenient registerContentFragmentSelectorAuthService function to register the ImsAuthService instance with the Content Fragment Selector. The following functions are available on the ImsAuthService class. However, if you are using the registerContentFragmentSelectorAuthService function, you do not need to call these functions directly.

Function Name
Description
isSignedInUser
Determines whether the user is currently signed in to the service and returns a boolean value accordingly.
getImsToken
Retrieves the authentication imsToken for the currently signed-in user, which can be used to authenticate requests to other services such as generating asset rendition.
signIn
Initiates the sign-in process for the user. This function uses the ImsAuthProps to show authentication in either a pop-up or a full page reload.
signOut
Signs the user out of the service, invalidating their authentication token and requiring them to sign in again to access protected resources. Invoking this function will reload the current page.
refreshToken
Refreshes the authentication token for the currently signed-in user, preventing it from expiring and ensuring uninterrupted access to protected resources. Returns a new authentication token that can be used for subsequent requests.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab