Ideal House
Zum Hauptinhalt springen

Shopify-Entwicklerintegration#

Fügen Sie einem Shopify-Theme die ideal.house-Schaltfläche hinzu und ordnen Sie sie der SKU der ausgewählten Variante zu.

<!-- DASHBOARD_READINESS -->

Vor dem Laden des SDK: Öffnen Sie Dashboard → Einstellungen, fügen Sie den Origin Ihres Onlineshops zu Allowed Origins (CORS) hinzu und klicken Sie auf Speichern. Berücksichtigen Sie den veröffentlichten Hostnamen sowie alle verwendeten Vorschau- oder Staging-Origins; trennen Sie mehrere Origins durch Kommas. Siehe Konfigurationsschritte.

1. Voraussetzungen bestätigen#

  • Sie können den Code des aktiven Themes oder einer sicheren Kopie des Themes bearbeiten.
  • Mindestens ein Testprodukt ist im Katalog importiert und aktiv.
  • Die SKU der ausgewählten Variante entspricht genau dem gespeicherten productCode, den der Katalog für diesen Shop verwendet.

2. Schreiben Sie den Button-Snippet#

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>

Halten Sie den Button verborgen, bis das SDK die Produkt-Eignung bestätigt.

3. Rendern Sie den Button in Theme-Oberflächen#

Sammlungs- und Such-Karten#

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

Häufige Dateien umfassen snippets/card-product.liquid, snippets/product-card.liquid oder snippets/product-grid-item.liquid. Passen Sie card_product an die vom Theme verwendete Produktvariable an.

Produkt-Detailseite#

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

Häufige Dateien umfassen sections/main-product.liquid oder snippets/product.liquid. Platzieren Sie separate Desktop- und Mobile-Renders nur, wenn das Theme separate Layouts hat.

4. Laden Sie das SDK und synchronisieren Sie Varianten#

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 definiert kein universelles Ereignis für Variantenänderungen in Themes. Verbinden Sie den folgenden kleinen Adapter mit dem Ereignis oder Callback, das beziehungsweise den das aktive Theme bereitstellt.

Theme-Event-Adapter-Beispiel#

Ersetzen Sie das Beispielereignis durch die Schnittstelle des aktiven Themes. Einige Themes veröffentlichen Ereignisse über window.subscribe; andere lösen ein DOM-Ereignis aus oder aktualisieren 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. Fügen Sie Theme-Stile hinzu#

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

Das Theme kann diese visuellen Stile überschreiben.

6. Assets in theme.liquid einbinden#

Binden Sie das Stylesheet für die Visualisierung und das Skript in layout/theme.liquid ein, um die Styles anzuwenden und den SDK-Loader zu aktivieren.

Stylesheet einbinden (innerhalb <head>)#

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

Platzieren Sie innerhalb des <head>-Tags von layout/theme.liquid, damit Stile sauber geladen werden.

Skript einbinden (vor </body>)#

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

Verwenden Sie defer und platzieren Sie unmittelbar vor dem schließenden </body>-Tag in layout/theme.liquid, um das Blockieren des Seiten-Renderings zu vermeiden.

Die Schaltfläche „In meinem Zimmer ansehen“ bleibt verborgen, bis dieses Loader-Skript in theme.liquid eingebunden ist.

7. Auf dem Live-Storefront verifizieren#

  1. Im Netzwerk-Panel ist zu sehen, dass sdk.js mit HTTP 200 geladen wurde.
  2. Der Wert data-product-code der selbst erstellten Schaltfläche stimmt exakt mit dem productCode im Katalog überein.
  3. Geeignete Produkte zeigen eine Schaltfläche; bei ungeeigneten Produkten bleibt sie verborgen.
  4. Ein Variantenwechsel aktualisiert data-product-code und validiert die Schaltfläche erneut.
  5. Die Platzierungen auf Kollektions- und Suchseiten sowie auf Produktdetailseiten für Desktop und Mobilgeräte funktionieren, sofern vorhanden.
  6. Ein Klick auf den Button öffnet den ideal.house Viewer mit dem ausgewählten Produkt.