init(options)
возвраты Promise<SpreeAISDK | null>. В случае успеха объект предоставляет renderTryOnButton(options): Promise<void>. Проверьте значение null перед рендерингом.
| Вариант | Тип | По умолчанию | Цель |
|---|---|---|---|
clientId | string | Требуется | Выданный идентификатор клиента браузера. |
baseApiURL | string | https://api.spreeai.com | Утвержденное происхождение API. Меняйте только для выданной среды. |
baseURL | string | https://vton.spreeai.com | Утверждено размещение примерочной происхождения. |
partnerId не является опцией инициализации в v3. Партнер определяется из аутентифицированного клиента. Никакой отдельный метод рендеринга для определения размера не возвращается.
renderTryOnButton(options)
| Вариант | Тип | По умолчанию/требование | Цель |
|---|---|---|---|
elementId | string | Требуется | Идентификатор существующего хост-элемента. |
garments | GarmentInput[] | Обязательный выбор | Рекомендуемый расход одежды. Используйте непустой массив. |
garmentId | string | Устаревшая альтернатива | Устаревший ввод одного предмета одежды. Отдавайте предпочтение одежде. |
variant | VariantOptions | Устарело | Устаревший фильтр с garmentId; предпочитайте вариант для каждого элемента. |
className | string | Необязательный | Дополнительный класс кнопки. |
button | { text?: string } | Необязательный | Надпись на кнопке; переопределен features.tryOnButton.text. |
features | TryOnFeatures | Необязательный | Настройка стиля кнопки. |
events | TryOnButtonEvents | Необязательный | Обработчики кликов и добавления в корзину. |
enableAddToCart | boolean | false | Отображение функции добавления в корзину. Реализовать обработчик. |
enableSizingRecommendation | boolean | false | Запросите рекомендации по размеру во время примерки. |
showSizes | boolean | false | Показать поставляемый availableSizes. |
showPrices | boolean | false | Показать цену поставки. |
defaultUnits | "metric" | "imperial" | Необязательный | Начальная система единиц измерения профиля. |
GarmentInput
| Поле | Тип | Цель |
|---|---|---|
garmentId | string | Требуемый идентификатор одежды SPREEAI. |
variant | VariantOptions | Дополнительный фильтр по цвету, посадке, полу или стилю. |
availableSizes | string[] | Дополнительные метки текущего размера дисплея. |
price | string | Цена опционального дисплея указана в состоянии поставки. |
Проверка и резервный вариант
Для одного предмета одежды перед рендерингом проверяются возможность участия и любой закрепленный вариант. Запросы на несколько предметов одежды ищут доступный подходящий наряд. Если ничего не найдено, SDK проверяет и отображает вместо этого первый предмет одежды. Если проверка не удалась, кнопка не отображается, а причина записывается в консоль.
Обратные вызовы
| Обратный звонок | Полезная нагрузка |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", одежда, setIsLoading, closePopUp, onError |
Корзина для одежды содержит необходимое количество id, partner_id, available и name, плюс опционально description и другие данные. Подтвердите, прежде чем добавлять в корзину. См. реализация корзины и стиль кнопки для примеров.
Не часть этой поверхности
В возвращенном SDK версии 3.0.0 не представлены документированные переключатели для каждого представления, автономный модуль запуска сравнения или автономный метод определения размера. features.loadingScreen был удален. Не делайте вывод о вызываемых методах из оставшихся экспортированных типов или устаревших комментариев.