Mikrofrontsväljare för mediefiler Overview

Version
Artikellänk
AEM 6.5
Klicka här
AEM as a Cloud Service
Den här artikeln

Micro-Frontend Asset Selector har ett användargränssnitt som enkelt kan integreras med Experience Manager Assets as a Cloud Service -databas så att du kan bläddra bland eller söka efter digitala resurser som är tillgängliga i databasen och använda dem när du redigerar program.

Användargränssnittet Micro-FrontEnd är tillgängligt i ditt program med hjälp av paketet Resursväljare. Alla uppdateringar av paketet importeras automatiskt och den senaste distribuerade resursväljaren läses in automatiskt i programmet.

Översikt

Resursväljaren har många fördelar, till exempel:

  • Enkel integrering med alla Adobe- och andra program med Vanilla JavaScript-bibliotek.

  • Enkelt att underhålla när uppdateringar av resursväljarpaketet automatiskt distribueras till resursväljaren som är tillgänglig för ditt program. Det finns inga uppdateringar som behövs i programmet för att läsa in de senaste ändringarna.

  • Enkel anpassning eftersom det finns tillgängliga egenskaper som styr visningen av resursväljaren i programmet.

  • Fulltextsökning, färdiga och anpassade filter för att snabbt navigera till material som ska användas i redigeringsmiljön.

  • Möjlighet att växla databaser inom en IMS-organisation för val av resurser.

  • Möjlighet att sortera resurser efter namn, dimensioner och storlek och visa dem i List-, Grid-, Gallery- eller Waterfall-vyn.

Artikelns omfattning är att visa hur du använder resursväljaren med en Adobe program under Unified Shell eller när du redan har en imsToken genererad för autentisering. Dessa arbetsflöden kallas icke-SUSI-flöde i den här artikeln.

Utför följande uppgifter för att integrera och använda resursväljaren med Experience Manager Assets as a Cloud Service databas:

Integrera resursväljare med Vanilla JS integration-with-vanilla-js

Du kan integrera alla Adobe eller program som inte är Adobe med Experience Manager Assets som Cloud Service arkivera och välja resurser inifrån programmet.

Integreringen görs genom att importera resursväljarpaketet och ansluta till Assets-as a Cloud Service med hjälp av Vanilla JavaScript-biblioteket. Du måste redigera en index.html eller en lämplig fil i programmet till -

  • Definiera autentiseringsinformationen
  • Åtkomst till den as a Cloud Service resurskatalogen
  • Konfigurera visningsegenskaperna för resursväljaren

Du kan utföra autentisering utan att definiera några IMS-egenskaper om:

  • Du integrerar en Adobe program på Enhetligt gränssnitt.
  • Du har redan en IMS-token genererad för autentisering.

Förutsättningar prerequisites

Definiera förutsättningarna i index.html -filen eller en liknande fil i programimplementeringen för att definiera autentiseringsinformationen för att komma åt Experience Manager Assets som Cloud Service databas. Förutsättningarna är följande:

  • imsOrg
  • imsToken
  • apikey

Installation installation

Resursväljare är tillgängliga via både ESM CDN (till exempel esm.sh/skypning) och UMD version.

I webbläsare som använder UMD-version (rekommenderas):

<script src="https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/assets-selectors.js"></script>

<script>
  const { renderAssetSelector } = PureJSSelectors;
</script>

I webbläsare med import maps support med ESM CDN-version:

<script type="module">
  import { AssetSelector } from 'https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/@assets/selectors/index.js'
</script>

I Deno/Webpack Module Federation med ESM CDN-version:

import { AssetSelector } from 'https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/@assets/selectors/index.js'

Markerad resurstyp selected-asset-type

Den valda resurstypen är en array med objekt som innehåller resursinformationen när resursen används handleSelection, handleAssetSelectionoch onDrop funktioner.

Schemasyntax

interface SelectedAsset {
    'repo:id': string;
    'repo:name': string;
    'repo:path': string;
    'repo:size': number;
    'repo:createdBy': string;
    'repo:createDate': string;
    'repo:modifiedBy': string;
    'repo:modifyDate': string;
    'dc:format': string;
    'tiff:imageWidth': number;
    'tiff:imageLength': number;
    'repo:state': string;
    computedMetadata: Record<string, any>;
    _links: {
        'http://ns.adobe.com/adobecloud/rel/rendition': Array<{
            href: string;
            type: string;
            'repo:size': number;
            width: number;
            height: number;
            [others: string]: any;
        }>;
    };
}

I följande tabell beskrivs några av de viktiga egenskaperna för det valda resursobjektet.

Egenskap
Typ
Förklaring
repo:databaseId
string
Unik identifierare för databasen där resursen lagras.
repo:id
string
Unik identifierare för tillgången.
repo:assetClass
string
Klassificeringen av resursen (till exempel bild eller video, dokument).
repo:name
string
Namnet på resursen, inklusive filtillägget.
repo:storlek
tal
Resursens storlek i byte.
repo:sökväg
string
Platsen för resursen i databasen.
repo:överordnade
Array<string>
En array med överordnade objekt för resursen i databasen.
repo:läge
string
Aktuellt läge för resursen i databasen (t.ex. aktiv, borttagen och så vidare).
repo:createdBy
string
Användaren eller systemet som skapade resursen.
repa:createDate
string
Datum och tid då tillgången skapades.
repo:modifiedBy
string
Den användare eller det system som senast ändrade resursen.
repo:modifyDate
string
Datum och tid då tillgången senast ändrades.
dc:format
string
Resursens format, till exempel filtypen (till exempel JPEG, PNG och så vidare).
tiff:imageWidth
tal
Bredden på en resurs.
tiff:imageLength
tal
En tillgångs höjd.
computedMetadata
Record<string, any>
Ett objekt som representerar en bucket för alla resursens metadata av alla slag (databas, program eller inbäddade metadata).
länkar
Record<string, any>
Hypermedialänkar för den associerade resursen. Innehåller länkar för resurser som metadata och återgivningar.
_links.http://ns.adobe.com/adobecloud/rel/rendition
Array<Object>
En array med objekt som innehåller information om återgivningar av resursen.
_links.http://ns.adobe.com/adobecloud/rel/rendition[].href
string
URI:n till återgivningen.
_links.http://ns.adobe.com/adobecloud/rel/rendition[].type
string
Återgivningens MIME-typ.
_links.http://ns.adobe.com/adobecloud/rel/rendition[].'repo:size'
tal
Återgivningens storlek i byte.
_links.http://ns.adobe.com/adobecloud/rel/rendition[].width
tal
Återgivningens bredd.
_links.http://ns.adobe.com/adobecloud/rel/rendition[].height
tal
Återgivningens höjd.

En fullständig lista över egenskaper och detaljerade exempel finns på Exempel på resursväljarkod.

Exempel på icke-SUSI-flöde non-susi-vanilla

I det här exemplet visas hur du använder resursväljaren med ett icke-SUSI-flöde när du kör ett Adobe program under Unified Shell eller när du redan har imsToken genereras för autentisering.

Inkludera paketet Resursväljare i koden med script -tagg, som i raderna 6-15 i exemplet nedan. När skriptet har lästs in visas PureJSSelectors global variabel är tillgänglig för användning. Definiera resursväljaren egenskaper som visas i raderna 16-23. The imsOrg och imsToken båda egenskaperna krävs för autentisering i icke-SUSI-flöden. The handleSelection -egenskapen används för att hantera de valda resurserna. Om du vill återge resursväljaren anropar du renderAssetSelector funktionen enligt rad 17. Resursväljaren visas i <div> behållarelement, som visas i raderna 21 och 22.

Följ de här stegen för att använda resursväljaren med ett icke-SUSI-flöde i Adobe program.

<!DOCTYPE html>
<html>
<head>
    <title>Asset Selector</title>
    <script src="https://experience.adobe.com/solutions/CQ-assets-selectors/assets/resources/assets-selectors.js"></script>
    <script>
        // get the container element in which we want to render the AssetSelector component
        const container = document.getElementById('asset-selector-container');
        // imsOrg and imsToken are required for authentication in non-SUSI flow
        const assetSelectorProps = {
            imsOrg: 'example-ims@AdobeOrg',
            imsToken: "example-imsToken",
            apiKey: "example-apiKey-associated-with-imsOrg",
            handleSelection: (assets: SelectedAssetType[]) => {},
        };
        // Call the `renderAssetSelector` available in PureJSSelectors globals to render AssetSelector
        PureJSSelectors.renderAssetSelector(container, assetSelectorProps);
    </script>
</head>

<body>
    <div id="asset-selector-container" style="height: calc(100vh - 80px); width: calc(100vw - 60px); margin: -20px;">
    </div>
</body>

</html>

Detaljerade exempel finns på Exempel på resursväljarkod.

Använd egenskaper för resursväljare asset-selector-properties

Du kan använda egenskaperna för resursväljaren för att anpassa hur resursväljaren återges. I följande tabell visas de egenskaper som du kan använda för att anpassa och använda resursväljaren.

Egenskap
Typ
Obligatoriskt
Standard
Beskrivning
järnväg
boolesk
Nej
false
Om markerad true, återges resursväljaren i en vy med vänster skena. Om den är markerad false, återges resursväljaren i modal vy.
imsOrg
string
Ja
IMS-ID (Adobe Identity Management System) som tilldelas vid etablering Adobe Experience Manager som Cloud Service för er organisation. The imsOrg Nyckeln krävs för att verifiera om den organisation du använder är under Adobe IMS eller inte.
imsToken
string
Nej
IMS-innehavartoken används för autentisering. imsToken krävs om du använder ett icke-SUSI-flöde.
apiKey
string
Nej
API-nyckel som används för åtkomst till AEM. apiKey krävs om du använder ett icke-SUSI-flöde.
rootPath
string
Nej
/content/dam/
Mappsökväg där resursväljaren visar dina resurser. rootPath kan också användas i form av inkapsling. Med följande sökväg /content/dam/marketing/subfolder/kan du inte bläddra igenom någon överordnad mapp, utan bara visa de underordnade mapparna.
bana
string
Nej
Sökväg som används för att navigera till en viss katalog med resurser när resursväljaren återges.
filterSchema
array
Nej
Modell som används för att konfigurera filteregenskaper. Detta är användbart när du vill begränsa vissa filteralternativ i Resursväljaren.
filterFormProps
Objekt
Nej
Ange de filteregenskaper som du behöver använda för att förfina sökningen. Exempel: MIME-typ JPG, PNG, GIF.
selectedAssets
Array <Object>
Nej
Ange valda resurser när resursväljaren återges. Det krävs en array med objekt som innehåller en id-egenskap för resurserna. Till exempel: [{id: 'urn:234}, {id: 'urn:555'}] En resurs måste vara tillgänglig i den aktuella katalogen. Om du behöver använda en annan katalog anger du ett värde för path också.
acvConfig
Objekt
Nej
Resurssamlingens visningsegenskap som innehåller objekt med anpassad konfiguration som åsidosätter standardvärden.
i18nSymboler
Object<{ id?: string, defaultMessage?: string, description?: string}>
Nej
Om OTB-översättningarna inte är tillräckliga för ditt programs behov kan du visa ett gränssnitt genom vilket du kan skicka dina egna anpassade lokaliserade värden via i18nSymbols prop. Om du skickar ett värde genom det här gränssnittet åsidosätts standardöversättningarna och i stället används dina egna. Om du vill utföra åsidosättningen måste du skicka en giltig Meddelandebeskrivning objekt till nyckeln för i18nSymbols som du vill åsidosätta.
intl
Objekt
Nej
Resursväljaren innehåller standardöversättningar, OOTB. Du kan välja översättningsspråk genom att ange en giltig språksträng via intl.locale prop. Till exempel: intl={{ locale: "es-es" }}

De språksträngar som stöds följer ISO 639 - Koder för representation av namn på språkstandarder.

Lista över språk som stöds: engelska - en-us (standard) spanska - 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
databaseId
string
Nej
'
Databas från vilken resursväljaren läser in innehållet.
additionalAemSolutions
Array<string>
Nej
[ ]
Här kan du lägga till en lista med ytterligare AEM. Om ingen information anges i den här egenskapen beaktas endast mediebibliotek eller AEM Assets-databaser.
hideTreeNav
boolesk
Nej
Anger om navigeringssidofältet för resursträd ska visas eller döljas. Den används endast i modal vy och därför har den här egenskapen ingen effekt i järnvägsvy.
onDrop
Funktion
Nej
Egenskapen gör att en resurs kan släppas.
dropOptions
{allowList?: Object}
Nej
Konfigurerar släppningsalternativ med tillåtelselista.
colorScheme
string
Nej
Konfigurera tema (light eller dark) för resursväljaren.
handleSelection
Funktion
Nej

Anropas med en array med tillgångsobjekt när resurser är markerade och Select klickar du på spärrknappen. Den här funktionen anropas bara i modal vy. För järnvägsvy använder du handleAssetSelection eller onDrop funktioner. Exempel:

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

Se Markerad resurstyp för mer information.

handleAssetSelection
Funktion
Nej

Anropas med en array med objekt när resurserna markeras eller avmarkeras. Detta är användbart när du vill lyssna efter resurser när användaren väljer dem. Exempel:

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

Se Markerad resurstyp för mer information.

onClose
Funktion
Nej
Anropas när Close knappen i modal vy trycks ned. Detta anropas bara modal visa och ignorera i rail vy.
onFilterSubmit
Funktion
Nej
Anropas med filterobjekt när användaren ändrar olika filtervillkor.
selectionType
string
Nej
enkel
Konfiguration för single eller multiple urval av resurser i taget.

Exempel på hur du använder egenskaper för resursväljare usage-examples

Du kan definiera resursväljaren egenskaper i index.html om du vill anpassa visningen av resursväljaren i programmet.

Exempel 1: Resursväljaren i vyn Räler

rail-view-example

Om värdet för AssetSelector rail är inställd på false eller inte omnämns i egenskaperna visas resursväljaren som standard i den modulala vyn.

Exempel 2: Metadatapuposer

Använd olika egenskaper för att definiera metadata för en resurs som du vill visa med hjälp av en informationsikon. Info pover innehåller information om resursen eller mappen, inklusive namn, dimensioner, ändringsdatum, plats och beskrivning av en resurs. I exemplet nedan används olika egenskaper för att visa metadata för en resurs, till exempel repo:path -egenskapen anger platsen för en resurs.

metadata-pover-exempel

Exempel 3: Egen filteregenskap i skenvy

Förutom den facetterade sökningen kan du med Resursväljaren anpassa olika attribut för att begränsa sökningen från Adobe Experience Manager som Cloud Service program. Du måste lägga till följande kod för att lägga till anpassade sökfilter i programmet. I exemplet nedan är Type Filter sökning som filtrerar resurstypen bland bilder, dokument eller videoklipp eller den filtertyp som du har lagt till för sökningen.

custom-filter-example-vanilla

Hantera urval av resurser med objektschema handling-selection

The handleSelection -egenskapen används för att hantera ett eller flera urval av resurser i Resursväljaren. I exemplet nedan anges syntaxen för användning av handleSelection.

handtag-markering

Använda resursväljare using-asset-selector

När resursväljaren har konfigurerats och du autentiserats för att använda resursväljaren med Adobe Experience Manager som Cloud Service kan du välja resurser eller utföra olika åtgärder för att söka efter dina resurser i databasen.

using-asset-selector

Visa/dölj panelen hide-show-panel

Om du vill dölja mappar i den vänstra navigeringen klickar du på Hide folders -ikon. Om du vill ångra ändringarna klickar du på Hide folders ikonen igen.

Databasväxlare repository-switcher

Med Resursväljaren kan du också växla databaser för val av resurser. Du kan välja vilken databas du vill använda i listrutan som finns i den vänstra panelen. De databasalternativ som är tillgängliga i listrutan baseras på repositoryId egenskap som definieras i index.html -fil. Den baseras på miljöer från den valda IMS-organisationen som den inloggade användaren har åtkomst till. Konsumenterna kan välja repositoryID och i så fall slutar resursväljaren återge repomkopplaren och återger resurser endast från den angivna databasen.

Resurskatalog

Det är en samling resursmappar som du kan använda för att utföra åtgärder.

Färdiga filter filters

Resursväljaren innehåller även färdiga filteralternativ som kan förfina sökresultaten. Följande filter är tillgängliga:

  • File type: innehåller mapp, fil, bilder, dokument eller video

  • MIME type: omfattar JPG, GIF, PPTX, PNG, MP4, DOCX, TIFF, PDF, XLSX

  • Image Size: innehåller minsta/högsta bredd, minsta/högsta höjd för bilden

    rail-view-example

Anpassad sökning

Förutom textsökningen kan du med Resursväljaren söka efter resurser i filer med hjälp av anpassad sökning. Du kan använda anpassade sökfilter både i den modulala vyn och i vyn Rail.

anpassad sökning

Du kan också skapa standardsökfilter för att spara de fält som du ofta söker efter och använda dem senare. Om du vill skapa en anpassad sökning efter dina resurser kan du använda filterSchema -egenskap.

Sökfältet search-bar

Med Resursväljaren kan du utföra fullständig textsökning av resurser i den valda databasen. Om du till exempel skriver nyckelordet wave i sökfältet, alla resurser som har wave nyckelord som nämns i någon av metadataegenskaperna visas.

Sortering sorting

Du kan sortera resurser i Resursväljaren efter namn, dimensioner eller storlek för en resurs. Du kan också sortera resurserna i stigande eller fallande ordning.

Typer av vy types-of-view

Med Resursväljaren kan du visa resursen i fyra olika vyer:

  • listvy : I listvyn visas rullningsbara filer och mappar i en enda kolumn.
  • stödrastervy : Stödrastervyn visar rullningsbara filer och mappar i ett rutnät med rader och kolumner.
  • gallerivy : I gallerivyn visas filer eller mappar i en centrerad vågrät lista.
  • vattenfallsvy : I vattenfallsvyn visas filer eller mappar i form av en Bridge.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab