init(options)
mga pagbabalik Promise<SpreeAISDK | null>. Sa tagumpay, ang bagay ay naglalantad renderTryOnButton(options): Promise<void>. Suriin ang null bago i-render.
| Pagpipilian | Uri | Default | Layunin |
|---|---|---|---|
clientId | string | Kinakailangan | Inisyu na browser client identifier. |
baseApiURL | string | https://api.spreeai.com | Naaprubahan na pinagmulan ng API. Baguhin lamang para sa isang ibinigay na kapaligiran. |
baseURL | string | https://vton.spreeai.com | Inaprubahang pinanggalingan ng naka-host na fitting-room. |
partnerId ay hindi isang opsyon sa init sa v3. Ang kasosyo ay nalutas mula sa napatotohanan na kliyente. Walang ibinalik na paraan ng pag-render ng standalone na sizing.
renderTryOnButton(options)
| Pagpipilian | Uri | Default / kinakailangan | Layunin |
|---|---|---|---|
elementId | string | Kinakailangan | ID ng kasalukuyang elemento ng host. |
garments | GarmentInput[] | Kinakailangang pagpipilian | Inirerekomendang pag-input ng damit. Gumamit ng hindi walang laman na array. |
garmentId | string | Hindi na ginagamit na alternatibo | Legacy na single-garment input. Mas gusto ang mga kasuotan. |
variant | VariantOptions | Hindi na ginagamit | Legacy na filter na may garmentId; mas gusto ang per-item na variant. |
className | string | Opsyonal | Karagdagang klase ng button. |
button | { text?: string } | Opsyonal | Label ng pindutan; na-override ng features.tryOnButton.text. |
features | TryOnFeatures | Opsyonal | Configuration ng pag-istilo ng button. |
events | TryOnButtonEvents | Opsyonal | Mga tagapangasiwa ng click at add-to-cart. |
enableAddToCart | boolean | false | Ipakita ang paggana ng add-to-cart. Ipatupad ang handler. |
enableSizingRecommendation | boolean | false | Humiling ng mga rekomendasyon sa pagpapalaki sa loob ng try-on. |
showSizes | boolean | false | Ipakita ang ibinigay na availableSizes. |
showPrices | boolean | false | Ipakita ang ibinigay na presyo. |
defaultUnits | "metric" | "imperial" | Opsyonal | Simula ng unit system para sa mga sukat ng profile. |
GarmentInput
| Patlang | Uri | Layunin |
|---|---|---|
garmentId | string | Kinakailangang SPREEAI garment identifier. |
variant | VariantOptions | Opsyonal na filter ng kulay, akma, kasarian o estilo. |
availableSizes | string[] | Opsyonal na kasalukuyang mga label ng laki ng display. |
price | string | Opsyonal na display na presyo, ipinapakita bilang ibinigay. |
Pagpapatunay at pagbabalik
Para sa isang kasuotan, ang pagiging kwalipikado at anumang naka-pin na variant ay sinusuri bago i-render. Ang mga kahilingan sa maraming damit ay naghahanap ng magagamit na katugmang damit. Kung walang matagpuan, ang SDK ang magpapatunay at magre-render sa unang damit. Kung nabigo ang pagpapatunay, walang button na ire-render at ang dahilan ay naka-log sa console.
Mga callback
| Callback | Payload |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", mga damit, setIsLoading, closePopUp, onError |
Ang mga kasuotan sa cart ay naglalaman ng kinakailangan id, partner_id, available at name, at opsyonal description at iba pang datos. Patunayan bago imapa sa iyong cart. Tingnan mo pagpapatupad ng cart at pag-istilo ng pindutan para sa mga halimbawa.
Hindi bahagi ng ibabaw na ito
Walang naka-dokumentong per-view na switch, standalone Compare launcher o standalone na paraan ng sizing ang naka-expose sa ibinalik na v3.0.0 SDK. features.loadingScreen ay tinanggal. Huwag maghinuha ng mga matatawag na pamamaraan mula sa mga natirang na-export na uri o mga lipas na komento.