Ideal House
Перейти к содержанию

Интеграция Shopify для разработчиков#

Добавьте кнопку ideal.house в тему Shopify и сопоставьте ее с выбранным SKU варианта.

<!-- DASHBOARD_READINESS -->

Перед загрузкой SDK: Откройте Панель управления → Настройки, добавьте адрес источника вашего магазина в Allowed Origins (CORS) и нажмите Сохранить. Укажите фактическое доменное имя опубликованного сайта, а также используемые адреса источников для предпросмотра и тестирования; несколько адресов разделяйте запятыми. См. инструкцию по настройке.

1. Подтвердите предварительные требования#

  • Вы можете редактировать код активной темы или безопасную копию темы.
  • По крайней мере, один тестовый товар импортирован и активен в каталоге.
  • Выбранный SKU варианта является тем же сохраненным productCode, который используется каталогом для этого магазина.

2. Создайте сниппет кнопки#

snippets/idealhouse-view-button.liquid#

liquid
{%- comment -%}
  Renders an ideal.house authored visualizer button.

  Accepts:
  - product_code: {String} Variant SKU used by the ideal.house Catalog mapping.
  - placement: {String} "card", "pdp-desktop", or "pdp-mobile".
{%- endcomment -%}

{%- liquid
  assign button_code = product_code | strip
  assign button_placement = placement | default: 'card'
-%}

<button
  type="button"
  class="idealhouse-view-button idealhouse-view-button--{{ button_placement | escape }}"
  data-idealhouse-authored-button
  data-active="false"
  {% if button_code != blank %}
    data-product-code="{{ button_code | escape }}"
  {% else %}
    disabled
  {% endif %}
  style="visibility: hidden;"
>
  <span>View in my room</span>
</button>

Держите кнопку скрытой, пока SDK не подтвердит пригодность товара.

3. Разместите кнопку в нужных разделах темы#

Карточки коллекций и поиска#

liquid
{%- render 'idealhouse-view-button',
  product_code: card_product.selected_or_first_available_variant.sku,
  placement: 'card'
-%}

Среди распространённых файлов: snippets/card-product.liquid, snippets/product-card.liquid или snippets/product-grid-item.liquid. Адаптируйте card_product под переменную товара, используемую в теме.

Страница с подробной информацией о товаре#

liquid
{%- render 'idealhouse-view-button',
  product_code: product.selected_or_first_available_variant.sku,
  placement: 'pdp-desktop'
-%}

{%- render 'idealhouse-view-button',
  product_code: product.selected_or_first_available_variant.sku,
  placement: 'pdp-mobile'
-%}

Среди распространённых файлов: sections/main-product.liquid или snippets/product.liquid. Размещайте отдельные рендеры для настольных и мобильных устройств только в том случае, если тема имеет отдельные макеты.

4. Загрузите SDK и синхронизируйте варианты#

assets/idealhouse-room-visualizer.js#

js
(function () {
  'use strict';

  var buttonSelector = '[data-idealhouse-authored-button]';
  var sdkRequested = false;
  var buttonObserver = null;

  function resetButton(button) {
    button.dataset.active = 'false';
    button.style.visibility = 'hidden';
    delete button.dataset.rvProductCode;
    delete button.dataset.rvProductType;
    delete button.dataset.rvProductId;
    delete button.dataset.rvProductIds;
  }

  function syncButton(button, productCode) {
    if (!button) return false;
    var code = typeof productCode === 'string' ? productCode.trim() : '';
    resetButton(button);
    delete button.dataset.productCode;

    if (!code) {
      button.disabled = true;
      return false;
    }

    button.disabled = false;
    button.dataset.productCode = code;
    return true;
  }

  function syncButtons(container, productCode) {
    (container || document).querySelectorAll(buttonSelector).forEach(function (button) {
      syncButton(button, productCode);
    });
  }

  function loadSdk() {
    if (sdkRequested || !document.querySelector(buttonSelector)) return false;
    sdkRequested = true;
    if (buttonObserver) buttonObserver.disconnect();

    var script = document.createElement('script');
    script.src = 'https://sdk.ideal.house/sdk.js';
    script.async = true;
    script.dataset.shopId = '<SHOP_ID>';
    script.dataset.publishableKey = '<PUBLISHABLE_KEY>';
    script.dataset.authoredButtonSelector = buttonSelector;
    document.head.appendChild(script);
    return true;
  }

  function startSdkLoader() {
    if (loadSdk() || typeof MutationObserver === 'undefined') return;
    buttonObserver = new MutationObserver(loadSdk);
    buttonObserver.observe(document.documentElement, { childList: true, subtree: true });
  }

  // Dispatch this event from your theme's variant-change callback.
  document.addEventListener('idealhouse:variant-change', function (event) {
    var detail = event.detail || {};
    syncButtons(detail.container || document, event.detail && event.detail.sku);
  });

  window.IdealhouseShopify = {
    syncButton: syncButton,
    syncButtons: syncButtons
  };

  if (document.readyState === 'loading') {
    document.addEventListener('DOMContentLoaded', startSdkLoader);
  } else {
    startSdkLoader();
  }
}());

Shopify не определяет единое универсальное событие варианта темы. Подключите небольшой адаптер ниже к событию или обратному вызову, который предоставляет активная тема.

Пример адаптера событий темы#

Замените пример события на API активной темы. Некоторые темы публикуют события через window.subscribe; другие отправляют событие DOM или обновляют product-info.

js
// Example only: replace "variant:change" with your theme's event.
document.addEventListener('variant:change', function (event) {
  var variant = event.detail && event.detail.variant;
  var productContainer = event.target.closest('product-info') || document;

  document.dispatchEvent(new CustomEvent('idealhouse:variant-change', {
    detail: {
      container: productContainer,
      sku: variant && variant.sku
    }
  }));
});

5. Добавьте стили темы#

assets/idealhouse-room-visualizer.css#

css
.idealhouse-view-button {
  align-items: center;
  justify-content: center;
  width: 100%;
  min-height: 44px;
  padding: 0.75rem 1rem;
  border: 1px solid currentColor;
  border-radius: 6px;
  background: transparent;
  color: inherit;
  cursor: pointer;
  font: inherit;
}

.idealhouse-view-button[data-active="true"] {
  display: inline-flex;
  visibility: visible;
}

.idealhouse-view-button:disabled {
  cursor: not-allowed;
  opacity: 0.5;
}

Тема может переопределять эти визуальные стили.

6. Подключите ресурсы в theme.liquid#

Подключите таблицу стилей и скрипт визуализатора в layout/theme.liquid, чтобы применить стили и активировать загрузчик SDK.

Подключите таблицу стилей (внутри <head>)#

liquid
{{ 'idealhouse-room-visualizer.css' | asset_url | stylesheet_tag }}

Разместите внутри тега <head> файла layout/theme.liquid, чтобы стили загружались корректно.

Включите скрипт (перед </body>)#

liquid
<script src="{{ 'idealhouse-room-visualizer.js' | asset_url }}" defer="defer"></script>

Используйте defer и поместите тег непосредственно перед закрывающим </body> в layout/theme.liquid, чтобы не блокировать отрисовку страницы.

Кнопка «Посмотреть в моей комнате» остается скрытой, пока этот скрипт загрузчика не будет включен в theme.liquid.

7. Проверьте опубликованный интернет-магазин#

  1. На вкладке сетевых запросов видно, что sdk.js загружен с кодом HTTP 200.
  2. Атрибут data-product-code созданной вручную кнопки точно совпадает с productCode в каталоге.
  3. Для товаров, поддерживающих визуализацию, кнопка становится видимой; для остальных она остаётся скрытой.
  4. Переключение варианта обновляет data-product-code и повторно валидирует кнопку.
  5. Размещения в коллекциях/поиске, на десктопной и мобильной страницах товара работают там, где они присутствуют.
  6. Нажатие на кнопку открывает Viewer ideal.house с выбранным товаром.