init(options)
Rückgaben Promise<SpreeAISDK | null>. Bei Erfolg wird das Objekt verfügbar gemacht renderTryOnButton(options): Promise<void>. Vor dem Rendern auf Null prüfen.
| Option | Typ | Standard | Zweck |
|---|---|---|---|
clientId | string | Erforderlich | Ausgegebene Browser-Client-ID. |
baseApiURL | string | https://api.spreeai.com | Genehmigter API-Ursprung. Nur für eine ausgegebene Umgebung ändern. |
baseURL | string | https://vton.spreeai.com | Zugelassener gehosteter Umkleideraum-Ursprung. |
partnerId ist in Version 3 keine Init-Option. Der Partner wird vom authentifizierten Client aufgelöst. Es wird keine eigenständige Rendermethode zur Größenanpassung zurückgegeben.
renderTryOnButton(options)
| Option | Typ | Standard / Anforderung | Zweck |
|---|---|---|---|
elementId | string | Erforderlich | ID des vorhandenen Hostelements. |
garments | GarmentInput[] | Erforderliche Auswahl | Empfohlene Kleidungsstückeingabe. Verwenden Sie ein nicht leeres Array. |
garmentId | string | Veraltete Alternative | Legacy-Einzelstück-Eingabe. Bevorzugen Sie Kleidungsstücke. |
variant | VariantOptions | Veraltet | Legacy-Filter mit garmentId; Bevorzugen Sie die Variante pro Artikel. |
className | string | Optional | Zusätzliche Schaltflächenklasse. |
button | { text?: string } | Optional | Knopfbeschriftung; überschrieben durch features.tryOnButton.text. |
features | TryOnFeatures | Optional | Konfiguration der Tastengestaltung. |
events | TryOnButtonEvents | Optional | Click- und Add-to-Cart-Handler. |
enableAddToCart | boolean | false | Zeigen Sie die Add-to-Cart-Funktion an. Implementieren Sie den Handler. |
enableSizingRecommendation | boolean | false | Fordern Sie während der Anprobe Größenempfehlungen an. |
showSizes | boolean | false | Mitgeliefertes availableSizes anzeigen. |
showPrices | boolean | false | Lieferpreis anzeigen. |
defaultUnits | "metric" | "imperial" | Optional | Ausgangseinheitensystem für Profilmessungen. |
GarmentInput
| Feld | Typ | Zweck |
|---|---|---|
garmentId | string | Erforderliche SPREEAI-Kleidungsstückkennung. |
variant | VariantOptions | Optionaler Farb-, Passform-, Geschlechts- oder Stilfilter. |
availableSizes | string[] | Optionale Etiketten zur aktuellen Anzeigegröße. |
price | string | Optionaler Anzeigepreis, angezeigt wie geliefert. |
Validierung und Fallback
Für ein einzelnes Kleidungsstück werden vor dem Rendern die Eignung und alle angehefteten Varianten überprüft. Bei Anfragen zu mehreren Kleidungsstücken suchen Sie nach einem verfügbaren passenden Outfit. Wenn keines gefunden wird, validiert und rendert das SDK stattdessen das erste Kleidungsstück. Wenn die Validierung fehlschlägt, wird keine Schaltfläche gerendert und der Grund wird in der Konsole protokolliert.
Rückrufe
| Rückruf | Nutzlast |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", Kleidungsstücke, setIsLoading, closePopUp, onError |
Warenkorb Kleidungsstücke enthalten erforderlich id, partner_id, available Und name, zusätzlich optional description und andere Daten. Überprüfen Sie dies, bevor Sie es Ihrem Warenkorb zuordnen. Siehe Warenkorb-Implementierung Und Knopf-Styling für Beispiele.
Nicht Teil dieser Oberfläche
Im zurückgegebenen SDK der Version 3.0.0 werden keine dokumentierten Schalter pro Ansicht, kein eigenständiger Vergleichsstarter oder eine eigenständige Größenanpassungsmethode verfügbar gemacht. features.loadingScreen wurde entfernt. Leiten Sie aufrufbare Methoden nicht aus übrig gebliebenen exportierten Typen oder veralteten Kommentaren ab.