Ideal House
Przejdź do treści

integracja deweloperska Shopify#

Dodaj przycisk ideal.house do motywu Shopify i zmapuj go na wybrany wariant SKU.

<!-- DASHBOARD_READINESS -->

Przed załadowaniem SDK: Otwórz Panel → Ustawienia, dodaj adres źródłowy witryny sklepu do Allowed Origins (CORS) i kliknij Zapisz. Uwzględnij rzeczywistą nazwę hosta opublikowanego sklepu oraz używane adresy podglądu i środowisk testowych; wiele adresów oddzielaj przecinkami. Zobacz instrukcję konfiguracji.

1. Potwierdź wymagania wstępne#

  • Możesz edytować kod motywu na żywo lub bezpieczną kopię motywu.
  • Przynajmniej jeden produkt testowy jest zaimportowany i aktywny w Katalogu.
  • Wybrany wariant SKU to ten sam utrwalony productCode używany przez Katalog dla tego Sklepu.

2. Utwórz fragment kodu przycisku#

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>

Utrzymuj przycisk ukryty, dopóki SDK nie potwierdzi kwalifikacji produktu.

3. Renderuj przycisk w powierzchniach motywu#

Karty kolekcji i wyszukiwania#

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

Powszechne pliki to snippets/card-product.liquid, snippets/product-card.liquid lub snippets/product-grid-item.liquid. Dostosuj card_product do zmiennej produktu używanej przez motyw.

Strona szczegółów produktu#

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'
-%}

Powszechne pliki to sections/main-product.liquid lub snippets/product.liquid. Umieszczaj osobne renderowania dla desktopa i mobilnego tylko wtedy, gdy motyw ma osobne układy.

4. Załaduj SDK i zsynchronizuj warianty#

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 nie definiuje jednego uniwersalnego zdarzenia wariantu motywu. Połącz mały adapter poniżej ze zdarzeniem lub wywołaniem zwrotnym udostępnionym przez aktywny motyw.

Przykład adaptera zdarzeń motywu#

Zamień przykładowe zdarzenie na API aktywnego motywu. Niektóre motywy publikują przez window.subscribe; inne wysyłają zdarzenie DOM lub aktualizują 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. Dodaj style motywu#

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;
}

Motyw może nadpisać te style wizualne.

6. Dołącz zasoby w theme.liquid#

Dołącz arkusz stylów wizualizatora i skrypt w layout/theme.liquid, aby zastosować style i aktywować loader SDK.

Dołącz arkusz stylów (wewnątrz <head>)#

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

Umieść wewnątrz etykiety <head> w layout/theme.liquid, aby style były ładowane czysto.

Dołącz skrypt (przed </body>)#

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

Użyj defer i umieść bezpośrednio przed zamykającą etykietą </body> w layout/theme.liquid, aby uniknąć blokowania renderowania strony.

Przycisk 'Zobacz w moim pokoju' pozostaje ukryty, dopóki ten skrypt loadera nie zostanie dołączony w theme.liquid.

7. Zweryfikuj na żywej witrynie sklepu#

  1. Panel Network pokazuje sdk.js załadowany z HTTP 200.
  2. Atrybut data-product-code własnego przycisku dokładnie odpowiada productCode w katalogu.
  3. Kwalifikowane produkty ujawniają przycisk; niekwalifikowane produkty utrzymują go ukrytego.
  4. Przełączanie wariantu aktualizuje data-product-code i ponownie weryfikuje przycisk.
  5. Umieszczenia w kolekcji/wyszukiwaniu, PDP desktop i PDP mobile działają tam, gdzie są obecne.
  6. Kliknięcie przycisku otwiera ideal.house Viewer z wybranym produktem.