Asset Selector properties asset-selector-properties

Property

Type

Required

Default

Description

Boolean

No

False

If marked true, Asset Selector is rendered in a left rail view. If it is marked false, the Asset Selector is rendered in modal view.

String

Yes

Adobe Identity Management System (IMS) ID that is assigned while provisioning Adobe Experience Manager as a Cloud Service for your organization. The imsOrg key is required to authenticate whether the organization you are accessing is under Adobe IMS or not.

String

No

IMS bearer token used for authentication. imsToken is required if you are using an Adobe application for the integration.

String

No

API key used for accessing the AEM Discovery service. apiKey is required if you are using an Adobe application integration.

Array

No

Model that is used to configure filter properties. This is useful when you want to limit certain filter options in Asset Selector.

Object

No

Specify the filter properties that you need to use to refine your search. For! example, MIME type JPG, PNG, GIF.

Array <Object>

No

Specify selected Assets when the Asset Selector is rendered. An array of objects is required that contains an id property of the assets. For example, [{id: 'urn:234}, {id: 'urn:555'}] An asset must be available in the current directory. If you need to use a different directory, provide a value for the path property as well.

Object

No

Asset Collection View property that contains object containing custom configuration to override defaults. Also, this property is used with rail property to enable rail view of assets viewer.

No

If the OOTB translations are insufficient for your application’s needs, you can expose an interface through which you can pass your own custom-localized values through the i18nSymbols prop. Passing a value through this interface overrides the default translations provided and instead use your own. To perform the override, you must pass a valid Message Descriptor object to the key of i18nSymbols that you want to override.

Object

No

Asset Selector provides default OOTB translations. You can select the translation language by providing a valid locale string through the intl.locale prop. For example: intl={{ locale: "es-es" }}

The locale strings supported follow the ISO 639 - Codes for the representation of names of languages standards.

List of supported locales: English - ‘en-us’ (default) Spanish - ‘es-es’ German - ‘de-de’ French - ‘fr-fr’ Italian - ‘it-it’ Japanese - ‘ja-jp’ Korean - ‘ko-kr’ Portuguese - ‘pt-br’ Chinese (Traditional) - ‘zh-cn’ Chinese (Taiwan) - ‘zh-tw’

String

No

‘’

Repository from where the Asset Selector loads the content.

No

[ ]

It lets you add a list of additional AEM repositories. If no information is provided in this property, then only media library or AEM Assets repositories are considered.

Boolean

No

Specifies whether to show or hide assets tree navigation sidebar. It is used in modal view only and hence there is no effect of this property in rail view.

Function

No

The property allows the drop functionality of an asset.

No

Configures drop options using ‘allowList’.

String

No

Configure theme (light or dark) for the Asset Selector.

String

No

Default

Apply theme to the Asset Selector application between default and express. It also supports @react-spectrum/theme-express.

Function

No

Invoked with array of Asset items when assets are selected and the Select button on the modal is clicked. This function is only invoked in modal view. For rail view, use the handleAssetSelection or onDrop functions. Example:

handleSelection=(assets: Asset[])=> {…}

See selection of assets for details.

Function

No

Invoked with array of items as the assets are being selected or unselected. This is useful when you want to listen for assets as user selects them. Example:

handleSelection=(assets: Asset[])=> {…}

See selection of assets for details.

Function

No

Invoked when Close button in modal view is pressed. This is only called in modal view and disregarded in rail view.

Function

No

Invoked with filter items as user changes different filter criteria.

String

No

Single

Configuration for single or multiple selection of assets at a time.

boolean

No

The property is used to allow or deny the dragging of assets that are not selectable.

String

No

It allows you to select whether you want to show assets from delivery tier, author tier, or both.

Syntax: aemTierType:[0]: "author" 1: "delivery"

For example, if both ["author","delivery"] are used, then the repository switcher displays options for both author and delivery.

Function

No

It is a Callback function to handle selection of an asset.

Boolean

No

The noWrap property helps rendering Asset Selector in the side rail panel. If this property is not mentioned, it renders the Dialog view by default.

small, medium, large, fullscreen, or fullscreen takeover

String

Optional

You can control the layout by specifying its size using the given options.

Light or dark

No

This property is used to set the theme of an Asset Selector application. You can choose between light or dark theme.

Function

No

You can use filterRepoList callback function that calls Experience Manager repository and returns a filtered list of repositories.

Function

You can use between the following two properties: getExpiryStatus which provides status of an expired asset. The function returns EXPIRED, EXPIRING_SOON or NOT_EXPIRED based on the expiry date of an asset that you provide. See customize expired assets. Additionally, you can use allowSelectionAndDrag in which the value of the function can either be true or false. When the value is set to false, the expired asset cannot be selected or dragged on the canvas.

No

It allows Asset Selector to show a customized toast message for the expired asset.

Array

No

Add an array of fields that you provide to gather metadata from the user. Using this property, you can also use hidden metadata which is assigned to an asset automatically but is not visible to the user.

Callback function

No

It consists of property and value. Property equals the mapToProperty of the field passed from the metadataSchema whose value is being updated. Whereas,value equals the new value is provided as an input.

String

The target upload path for the files which defaults to root of the assets repository.

Boolean

False

It ensures if the internal upload button should be hidden or not.

Function

No

It is a callback function which is used to pass the upload source among Dropbox, OneDrive, or local. The syntax is (uploadInfo: UploadInfo) => void

Function

It enables the support for importing assets from third party source. sourceTypes uses an array of the import sources that you want to enable. The supported sources are Onedrive and Dropbox. The syntax is { sourceTypes?: ImportSourceType[]; apiKey?: string; }

Function

No

It is a callback function which is used to pass the file upload status among succeeded, failed, or duplicate. The syntax is (uploadStats: UploadStats) => void

Function

No

It is a callback function which is used to show the behavior of upload when a file is changed. It passes the new array of files pending for upload and the source type of the upload. Source type can be null in case of error. The syntax is (newFiles: File[], uploadType: UploadType) => void

String

It is a placeholder image that replaces the metadata form when an upload of the asset is initiated. The syntax is { href: string; alt: string; }

Object

It is an object that contains customized configuration for the upload.

Array

String

The featureSet:[ ] property is used to enable or disable a particular functionaly in the Asset Selector application. To enable the component or a feature, you can pass a string value in the array or leave the array empty to disable that component. For example, you want to enable upload functionality in the Asset Selector, use the syntax featureSet:[0:"upload"].