init(options)
returer Promise<SpreeAISDK | null>. Vid framgång avslöjar objektet renderTryOnButton(options): Promise<void>. Kontrollera om det finns noll innan du renderar.
| Alternativ | Typ | Standard | Syfte |
|---|---|---|---|
clientId | string | Obligatoriskt | Utfärdad webbläsarklientidentifierare. |
baseApiURL | string | https://api.spreeai.com | Godkänt API-ursprung. Ändra endast för en utfärdad miljö. |
baseURL | string | https://vton.spreeai.com | Godkänd värd provrumsursprung. |
partnerId är inte ett init-alternativ i v3. Partnern löses från den autentiserade klienten. Ingen fristående renderingsmetod för storlek returneras.
renderTryOnButton(options)
| Alternativ | Typ | Standard/krav | Syfte |
|---|---|---|---|
elementId | string | Obligatoriskt | ID för det befintliga värdelementet. |
garments | GarmentInput[] | Obligatoriskt val | Rekommenderad plagginmatning. Använd en icke-tom array. |
garmentId | string | Utgått alternativ | Äldre ingång för ett plagg. Föredrar plagg. |
variant | VariantOptions | Utfasad | Äldre filter med garmentId; föredrar en variant per artikel. |
className | string | Frivillig | Ytterligare knappklass. |
button | { text?: string } | Frivillig | Knappetikett; åsidosatt av features.tryOnButton.text. |
features | TryOnFeatures | Frivillig | Knappstilskonfiguration. |
events | TryOnButtonEvents | Frivillig | Klicka och lägg i kundvagn hanterare. |
enableAddToCart | boolean | false | Visa funktionen för tillägg i kundvagnen. Implementera hanteraren. |
enableSizingRecommendation | boolean | false | Begär storleksrekommendationer i prova på. |
showSizes | boolean | false | Visa medföljande availableSizes. |
showPrices | boolean | false | Visa medlevererat pris. |
defaultUnits | "metric" | "imperial" | Frivillig | Startenhetssystem för profilmätningar. |
GarmentInput
| Fält | Typ | Syfte |
|---|---|---|
garmentId | string | Obligatorisk SPREEAI plaggidentifierare. |
variant | VariantOptions | Valfritt färg-, passform-, köns- eller stilfilter. |
availableSizes | string[] | Valfria etiketter för aktuell displaystorlek. |
price | string | Valfritt visningspris, visas som levererat. |
Validering och fallback
För ett enskilt plagg kontrolleras valbarheten och eventuella nålade varianter innan rendering. Förfrågningar om flera plagg letar efter en tillgänglig matchande outfit. Om ingen hittas, validerar och återger SDK det första plagget istället. Om valideringen misslyckas renderas ingen knapp och orsaken loggas till konsolen.
Återuppringningar
| Återuppringning | Nyttolast |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", plagg, setIsLoading, closePopUp, onError |
Varukorgskläder innehåller obligatoriska id, partner_id, available och name, plus valfritt description och andra uppgifter. Validera innan du mappar till din kundvagn. Se vagnimplementering och knappstyling för exempel.
Inte en del av denna yta
Inga dokumenterade per-view-switchar, fristående Compare launcher eller fristående storleksmetod exponeras på den returnerade v3.0.0 SDK. features.loadingScreen har tagits bort. Dra inte slutledning om anropsbara metoder från överblivna exporterade typer eller inaktuella kommentarer.